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