Project

General

Profile

Onboarding API Spec » History » Version 4

Ryan Supawarapong, 02/18/2026 09:18 AM

1 1 Ryan Supawarapong
# Onboarding API Spec
2
3
**Table of content**
4
- [Fullname](#Fullname)
5
- [Verify](#Verify)
6
7
## Fullname
8
9 3 Ryan Supawarapong
10 1 Ryan Supawarapong
| Type    | Value  |
11
| --------| ---- | 
12 4 Ryan Supawarapong
| API Path| `/onboarding/v1/fullname` |
13
| Request Type | `POST` |
14
| Content-Type | `application/json` |
15 1 Ryan Supawarapong
16 4 Ryan Supawarapong
### Request Body
17
18
| JSON Path | Type | Example | Required |
19
|---|---|---|---|
20
| title | string | "Mr." | yes |
21
| thName | string | "สมชาย" | yes |
22
| thMiddlename | string | "ใจดี" | no |
23
| thSurname | string | "รักดี" | yes |
24
| enName | string | "Somchai" | yes |
25
| enMiddlename | string | "Jaidee" | no |
26
| enSurname | string | "Rakdee" | yes |
27
| email | string | "somchai@example.com" | yes |
28
| mobile | string | "0812345678" | yes |
29
| citizenship | integer | 764 | yes |
30
31
### Example response body
32
33
| Body | Value |
34
|---|---|
35
| JSON | `{"status":"success","xid":"xRequestID"}` |
36
37
##### Error Response (400)
38
39
| JSON Path | Type | Example | Required |
40
|---|---|---|---|
41
| error | string | "duplicate email, mobile" | yes |
42 3 Ryan Supawarapong
43
### Diagram
44
45
<img style="width: 324px;" src="clipboard-202602181537-fdab7.png"><br>
46 1 Ryan Supawarapong
47
## Verify
48
49
| Type    | Value  |
50
| --------| ---- | 
51
| API Path| /onboarding/v1/verify |
52 2 Ryan Supawarapong
| Request Type | POST |