Project

General

Profile

Onboarding Foreign API Spc » History » Version 2

Ryan Supawarapong, 03/02/2026 02:49 AM

1 1 Ryan Supawarapong
# Onboarding Foreign API Spc
2
3
4 2 Ryan Supawarapong
## Customer Precreate
5
6
| Type | Value |
7 1 Ryan Supawarapong
|---|---|
8 2 Ryan Supawarapong
| API Path | `/api/v1/foreign/individual/ico/precreate` |
9
| Request Type | `POST` |
10 1 Ryan Supawarapong
| Content-Type | `application/json` |
11 2 Ryan Supawarapong
| Authorization | `Bearer ...` |
12 1 Ryan Supawarapong
13
### Request Body
14
15 2 Ryan Supawarapong
| Key | Type | Example | Required |
16
|---|---|---|---|
17
| title | string | `"Mr."` | yes |
18
| name | string | `"John"` | yes |
19
| surname | string | `"Doe"` | yes |
20
| email | string | `"john@doe.com"` | yes |
21
| mobile | string | `"0987654321"` | yes |
22
| birthDate | string (date-time) | `"1990-01-01T00:00:00Z"` | yes |
23
| marriageStatus | string | `"Single"` | yes |
24
| nationality | string | `"USA"` | yes |
25
| passportNumber | string | `"AC123435"` | yes |
26
| expirationDate | string (date-time) | `"2030-01-01T00:00:00Z"` | yes |
27
| agreement | boolean | `true` | yes |
28 1 Ryan Supawarapong
29 2 Ryan Supawarapong
### Success Response (200)
30 1 Ryan Supawarapong
31 2 Ryan Supawarapong
| JSON Path | Type | Example | Required |
32
|---|---|---|---|
33
| status | string | `"success"` | yes |
34
| data | object | `{"registerID":"registerId"}` | yes |
35
| data.registerID | string | `"registerId"` | no (`omitempty`) |
36
| data.alreadyExist | boolean | `true` | no (`omitempty`) |
37
| xid | string | `"xRequestId"` | no |
38
| header.X-Request-ID | string | `"xRequestId"` | yes (header) |
39 1 Ryan Supawarapong
40
### Error Response
41
42 2 Ryan Supawarapong
#### Bad Request (400)
43
| JSON Path | Type | Example | Required |
44
|---|---|---|---|
45
| status | string | `"error"` | yes |
46
| message | string | `"validation failed"` | yes |
47
| xid | string | `"xRequestId"` | no |
48
49
#### Internal Server Error (500)
50
| JSON Path | Type | Example | Required |
51
|---|---|---|---|
52
| status | string | `"error"` | yes |
53
| message | string | `"internal error"` | yes |
54
| xid | string | `"xRequestId"` | no |