Customer WebApp » Onboarding Foreign »
« Previous |
Revision 3/12
(diff)
| Next »
Ryan Supawarapong, 03/02/2026 02:50 AM
Onboarding Foreign API Spc¶
Customer Precreate¶
| Type |
Value |
| API Path |
/api/v1/foreign/individual/ico/precreate |
| Request Type |
POST |
| Content-Type |
application/json |
| Authorization |
Bearer ... |
Request Body¶
| Key |
Type |
Example |
Required |
| title |
string |
"Mr." |
yes |
| name |
string |
"John" |
yes |
| surname |
string |
"Doe" |
yes |
| email |
string |
"john@doe.com" |
yes |
| mobile |
string |
"0987654321" |
yes |
| birthDate |
string (date-time) |
"1990-01-01T00:00:00Z" |
yes |
| marriageStatus |
string |
"Single" |
yes |
| nationality |
string |
"USA" |
yes |
| passportNumber |
string |
"AC123435" |
yes |
| expirationDate |
string (date-time) |
"2030-01-01T00:00:00Z" |
yes |
| agreement |
boolean |
true |
yes |
Success Response (200)¶
| JSON Path |
Type |
Example |
Required |
| status |
string |
"success" |
yes |
| data |
object |
{"registerID":"registerId"} |
yes |
| data.registerID |
string |
"registerId" |
no (omitempty) |
| data.alreadyExist |
boolean |
true |
no (omitempty) |
| xid |
string |
"xRequestId" |
yes |
Error Response¶
Bad Request (400)¶
| JSON Path |
Type |
Example |
Required |
| status |
string |
"error" |
yes |
| message |
string |
"validation failed" |
yes |
| xid |
string |
"xRequestId" |
no |
Internal Server Error (500)¶
| JSON Path |
Type |
Example |
Required |
| status |
string |
"error" |
yes |
| message |
string |
"internal error" |
yes |
| xid |
string |
"xRequestId" |
no |
Updated by Ryan Supawarapong about 2 months ago
· 12 revisions