Onboarding API Spec » History » Revision 11
Revision 10 (Ryan Supawarapong, 02/19/2026 01:34 AM) → Revision 11/15 (Ryan Supawarapong, 02/19/2026 04:05 AM)
# Onboarding API Spec **Table of content** - [Fullname](#Fullname) - [Verify](#Verify) - [Knowledge Test](#Knowledge-Test) - [Address](#Address) ## Fullname | Type | Value | | --------| ---- | | API Path| `/onboarding/v1/fullname` | | Request Type | `POST` | | Content-Type | `application/json` | ### Request Body | Key JSON Path | Type | Example | Required | |-----|------|---------|----------| |---|---|---|---| | `title` title | string | `"Mr."` "Mr." | yes | | `thName` thName | string | `"สมชาย"` "สมชาย" | yes | | `thMiddlename` thMiddlename | string | `"ใจดี"` "ใจดี" | no | | `thSurname` thSurname | string | `"รักดี"` "รักดี" | yes | | `enName` enName | string | `"Somchai"` "Somchai" | yes | | `enMiddlename` enMiddlename | string | `"Jaidee"` "Jaidee" | no | | `enSurname` enSurname | string | `"Rakdee"` "Rakdee" | yes | | `email` email | string | `"somchai@example.com"` "somchai@example.com" | yes | | `mobile` mobile | string | `"0812345678"` "0812345678" | yes | | `citizenship` citizenship | integer | `764` 764 | yes | ### response body | Key | Type | example | Required | |---- |-------| ------- | -------- | | `status` | string | "success" | yes | | `xid` | string | "c4336914-d359-4ca7-ba0f-edc51b9d27ee" | yes | | `data` | null | null | no | ##### Error Response (400) | Key JSON Path | Type | Example | Required | |-----|------|---------|----------| |---|---|---|---| | error | string | "duplicate email, mobile" | yes | ### Diagram <img style="width: 324px;" src="clipboard-202602181537-fdab7.png"><br> ## Verify | Type | Value | | --------| ------ ---- | | API Path| /onboarding/v1/verify/init /onboarding/v1/verify | | Request Type | POST | ### Request Body | Key | Type | Example | Required | |-----|------|---------|----------| | `registerId` | string | `"c4336914-d359-4ca7-ba0f-edc51b9d27ee"` | yes | | `email` | string | `"user@example.com"` | no | | `mobile` | string | `"081234567890"` | no | | `referenceCode` | string | `"REF123456"` | no | | `otp` | string | `"123456"` | no | | `isMobileVerify` | bool | `true` | no | | `isEmailVerify` | bool | `false` | no | | `ip` | string | `"203.0.113.10"` | no | ### Example response body ##### Error Response (400) ### Diagram ## Address | Type | Value | | --------| ------ ---- | | API Path| /onboarding/v1/TBA | | Request Type | TBA | ### Request Body | Key | Type | Example | Required | |-----|------|---------|----------| ### Example response body | Key | Type | Example | Required | |-----|------|---------|----------| ##### Error Response (400) | Key | Type | Example | Required | |-----|------|---------|----------| ### Diagram ## Knowledge Test | Type | Value | | --------| ---- | | API Path| /onboarding/v1/TBA | | Request Type | TBA | ### Request Body | Key | Type | Example | Required | |-----|------|---------|----------| ### Example response body | Key | Type | Example | Required | |-----|------|---------|----------| ##### Error Response (400) | Key | Type | Example | Required | |-----|------|---------|----------| ### Diagram