Onboarding API Spec¶
THis will use Response_Specification as the baseline response body for the payload.
Table of content
Fullname¶
| Type |
Value |
| API Path |
/onboarding/v1/fullname |
| Request Type |
POST |
| Content-Type |
application/json |
Request Body¶
| Key |
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 |
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 |
Type |
Example |
Required |
| error |
string |
"duplicate email, mobile" |
yes |
Diagram¶
Init Verify¶
| Type |
Value |
| API Path |
/onboarding/v1/verify/init |
| Request Type |
POST |
Verify¶
| Type |
Value |
| API Path |
/onboarding/v1/verify/confirm |
| 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¶
| Key |
Type |
example |
Required |
status |
string |
"success" |
yes |
xid |
string |
"c4336914-d359-4ca7-ba0f-edc51b9d27ee" |
yes |
data |
map[string]any |
{"data": {"referenceCode":"XGEFSD"}} |
yes |
Error Response (400)¶
| Key |
Type |
example |
Required |
data |
map[string]any |
{"errors": {"field": "email", "message": "email is required when mobile is empty"} } |
yes |
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¶