Project

General

Profile

Onboarding API Spec » History » Revision 5

Revision 4 (Ryan Supawarapong, 02/18/2026 09:18 AM) → Revision 5/15 (Ryan Supawarapong, 02/19/2026 01:25 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 

 | JSON Path | Type | Example | Required | 
 |---|---|---|---| 
 | title | string | "Mr." | yes | 
 | thName | string | "สมชาย" | yes | 
 | thMiddlename | string | "ใจดี" | no | 
 | thSurname | string | "รักดี" | yes | 
 | enName | string | "Somchai" | yes | 
 | enMiddlename | string | "Jaidee" | no | 
 | enSurname | string | "Rakdee" | yes | 
 | email | string | "somchai@example.com" | yes | 
 | mobile | string | "0812345678" | yes | 
 | citizenship | integer | 764 | yes | 

 ### Example response body 

 | Body | Value | 
 |---|---| 
 | JSON | `{"status":"success","xid":"xRequestID"}` | 

 ##### Error Response (400) 

 | 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 | 
 | Request Type | POST | 


 ## Knowledge Test 

 | Type      | Value    | 
 | --------| ---- |  
 | API Path| /onboarding/v1/TBA | 
 | Request Type | TBA | 

 ## Address 

 | Type      | Value    | 
 | --------| ---- |  
 | API Path| /onboarding/v1/TBA | 
 | Request Type | TBA |