Customer WebApp » Onboarding Foreign »
Revision 1/12
| Next »
Ryan Supawarapong, 03/02/2026 02:48 AM
Onboarding Foreign API Spc¶
API Spec (from unit test example)¶
| Item |
Spec |
| Endpoint |
POST /api/v1/foreign/individual/ico/precreate |
| Description |
Create pre-registration info for foreign individual onboarding |
| Content-Type |
application/json |
| Response Content-Type |
application/json |
| Success Status |
200 OK |
| Error Status |
400 Bad Request, 500 Internal Server Error
|
| Response Header |
X-Request-ID: <uuid> |
| Response Envelope |
{ "status": "success|error", "data": {...}, "message": "...", "xid": "..." } |
Request Body¶
| Field |
Type |
Required |
Format/Validation |
Example |
title |
string |
✅ |
non-empty |
Mr. |
name |
string |
✅ |
non-empty |
John |
surname |
string |
✅ |
non-empty |
Doe |
email |
string |
✅ |
valid email |
john@doe.com |
mobile |
string |
✅ |
non-empty |
0987654321 |
birthDate |
string |
✅ |
RFC3339 date-time |
1990-01-01T00:00:00Z |
marriageStatus |
string |
✅ |
non-empty |
Single |
nationality |
string |
✅ |
non-empty |
USA |
passportNumber |
string |
✅ |
non-empty |
AC123435 |
expirationDate |
string |
✅ |
RFC3339 date-time |
2030-01-01T00:00:00Z |
agreement |
boolean |
✅ |
must be present |
true |
200 Response (status = success)¶
| Scenario |
data payload |
| New register |
{ "registerID": "registerId" } |
| Already exists |
{ "alreadyExist": true } |
Error Response¶
| HTTP Code |
status |
Body shape |
400 |
error |
{ "status":"error", "message":"<error>", "xid":"<uuid>" } |
500 |
error |
{ "status":"error", "message":"<error>", "xid":"<uuid>" } |
Updated by Ryan Supawarapong about 2 months ago
· 12 revisions