Onboarding API Spec » History » Version 12
Ryan Supawarapong, 02/19/2026 06:00 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 | 11 | Ryan Supawarapong | | Key | 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 | 4 | Ryan Supawarapong | |
| 33 | 8 | Ryan Supawarapong | ### response body |
| 34 | 1 | Ryan Supawarapong | |
| 35 | 8 | Ryan Supawarapong | | Key | Type | example | Required | |
| 36 | |---- |-------| ------- | -------- | |
||
| 37 | | `status` | string | "success" | yes | |
||
| 38 | | `xid` | string | "c4336914-d359-4ca7-ba0f-edc51b9d27ee" | yes | |
||
| 39 | | `data` | null | null | no | |
||
| 40 | 4 | Ryan Supawarapong | |
| 41 | ##### Error Response (400) |
||
| 42 | |||
| 43 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 44 | |-----|------|---------|----------| |
||
| 45 | 1 | Ryan Supawarapong | | error | string | "duplicate email, mobile" | yes | |
| 46 | |||
| 47 | ### Diagram |
||
| 48 | |||
| 49 | <img style="width: 324px;" src="clipboard-202602181537-fdab7.png"><br> |
||
| 50 | |||
| 51 | ## Verify |
||
| 52 | |||
| 53 | | Type | Value | |
||
| 54 | 11 | Ryan Supawarapong | | --------| ------ | |
| 55 | | API Path| /onboarding/v1/verify/init | |
||
| 56 | 3 | Ryan Supawarapong | | Request Type | POST | |
| 57 | |||
| 58 | |||
| 59 | 1 | Ryan Supawarapong | ### Request Body |
| 60 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 61 | |-----|------|---------|----------| |
||
| 62 | | `registerId` | string | `"c4336914-d359-4ca7-ba0f-edc51b9d27ee"` | yes | |
||
| 63 | | `email` | string | `"user@example.com"` | no | |
||
| 64 | | `mobile` | string | `"081234567890"` | no | |
||
| 65 | | `referenceCode` | string | `"REF123456"` | no | |
||
| 66 | | `otp` | string | `"123456"` | no | |
||
| 67 | | `isMobileVerify` | bool | `true` | no | |
||
| 68 | | `isEmailVerify` | bool | `false` | no | |
||
| 69 | | `ip` | string | `"203.0.113.10"` | no | |
||
| 70 | 1 | Ryan Supawarapong | |
| 71 | |||
| 72 | 8 | Ryan Supawarapong | ### Example response body |
| 73 | |||
| 74 | 12 | Ryan Supawarapong | |
| 75 | |||
| 76 | 1 | Ryan Supawarapong | ##### Error Response (400) |
| 77 | |||
| 78 | 8 | Ryan Supawarapong | ### Diagram |
| 79 | |||
| 80 | 1 | Ryan Supawarapong | |
| 81 | ## Address |
||
| 82 | 8 | Ryan Supawarapong | |
| 83 | 9 | Ryan Supawarapong | | Type | Value | |
| 84 | 11 | Ryan Supawarapong | | --------| ------ | |
| 85 | 9 | Ryan Supawarapong | | API Path| /onboarding/v1/TBA | |
| 86 | 10 | Ryan Supawarapong | | Request Type | TBA | |
| 87 | 5 | Ryan Supawarapong | |
| 88 | ### Request Body |
||
| 89 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 90 | |-----|------|---------|----------| |
||
| 91 | 1 | Ryan Supawarapong | |
| 92 | ### Example response body |
||
| 93 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 94 | |-----|------|---------|----------| |
||
| 95 | 1 | Ryan Supawarapong | |
| 96 | 8 | Ryan Supawarapong | ##### Error Response (400) |
| 97 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 98 | |-----|------|---------|----------| |
||
| 99 | 8 | Ryan Supawarapong | |
| 100 | ### Diagram |
||
| 101 | 1 | Ryan Supawarapong | |
| 102 | |||
| 103 | 8 | Ryan Supawarapong | ## Knowledge Test |
| 104 | |||
| 105 | 9 | Ryan Supawarapong | | Type | Value | |
| 106 | 1 | Ryan Supawarapong | | --------| ---- | |
| 107 | 8 | Ryan Supawarapong | | API Path| /onboarding/v1/TBA | |
| 108 | 10 | Ryan Supawarapong | | Request Type | TBA | |
| 109 | 5 | Ryan Supawarapong | |
| 110 | 1 | Ryan Supawarapong | ### Request Body |
| 111 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 112 | |-----|------|---------|----------| |
||
| 113 | 1 | Ryan Supawarapong | |
| 114 | ### Example response body |
||
| 115 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 116 | |-----|------|---------|----------| |
||
| 117 | 8 | Ryan Supawarapong | |
| 118 | ##### Error Response (400) |
||
| 119 | 11 | Ryan Supawarapong | | Key | Type | Example | Required | |
| 120 | |-----|------|---------|----------| |
||
| 121 | 9 | Ryan Supawarapong | |
| 122 | ### Diagram |