Appearance
Send Multi-Step Registration Request for Approval
About 430 wordsAbout 1 min
POST /public/v1/account/register/multistep
Request Body
| Name | Type | Required | Rule | Description |
|---|---|---|---|---|
| trader_register | string | Mandatory | trader_register | |
| register | object | Mandatory | Trader's registration form information, same form as this | |
| register.email | string | Mandatory | email | the email of user |
| register.type | string | Mandatory | trader | the type of user |
| register.phone | object | Optional | the phone of user | |
| register.phone.country_code | string | Optional | user's phone country code | |
| register.phone.number | string | Optional | user's phone number | |
| register.email_code | string | Mandatory | length 6 | the OTP sent by email |
| register.phone_code | string | Mandatory | length 6 | the OTP sent by phone SMS |
| register.password | string | Mandatory | the password of user | |
| register.repeat_password | string | Mandatory | repeat password of user | |
| register.form_id | string | Mandatory | length 8 | the id of registration form |
| register.link_id | string | Optional | length 8 | the id of referral link |
| register.referrer_id | string | Optional | length 8 | the referrel code of the referrer |
register.custom_fields | fields | Optional | additional fields configured in registration form | |
| kyc | object | Mandatory | Trader's kyc form information | |
| kyc.form_id | string | Mandatory | length 8 | the id of kyc form |
kyc.custom_fields | fields | Optional | additional fields configured in kyc form | |
| language | string | Optional | language code | language for email |
One-Time Password Types
| Code |
|---|
email |
phone (if you installed twilio) |
Expected HTTP status code
- 204
Error
| Code | Type | Description |
|---|---|---|
400 | invalid_validation_code | No Email or phone otp is sent |
Custom Field
Custom fields are JSON root fields. The field key is a random key obtained from the form, and the value follows the example format below.
| Type | Input Format | Example |
|---|---|---|
text / textarea / description | String | "Hello World" |
number | Number | 123.45 |
number_string | Numeric String | "123456789" |
boolean | Boolean | true or false |
radio / select | String | "option1" |
dynamicSelect | Any | "any_value" |
multiselect / checkbox | Array | ["value1", "value2"] |
date | String (YYYY-MM-DD) | "2024-06-15" |
document | Array of Objects | [{"id": "doc123", "name": "file.pdf", "doc": "base64"}] |
phone | Object | {"country_code": "86", "number": "13800138000"} |
email | String | "[email protected]" |
country / nation | String | "CN" |
location | Object | {"country": "CN", "state": "GD", "city": "SZ"} |
participants / leads | Array | [{...}, {...}] |
Complete JSON Example
{
"custom_key_text": "Hello World",
"custom_key_textarea": "This is a long text content for textarea field",
"custom_key_description": "This is a description field content",
"custom_key_number": 123.45,
"custom_key_number_string": "123456789",
"custom_key_boolean": true,
"custom_key_radio": "option1",
"custom_key_select": "option2",
"custom_key_dynamicSelect": "dynamic_value",
"custom_key_multiselect": ["value1", "value2", "value3"],
"custom_key_checkbox": ["option1", "option2"],
"custom_key_date": "2024-06-15",
"custom_key_document": [
{
"id": "doc001",
"name": "ID_Card.pdf",
"doc": "base64_encoded_string"
}
],
"custom_key_phone": {
"country_code": "86",
"number": "13800138000"
},
"custom_key_email": "[email protected]",
"custom_key_country": "CN",
"custom_key_nation": "CN",
"custom_key_location": {
"country": "CN",
"state": "Guangdong",
"city": "Shenzhen"
},
"custom_key_participants": [
{ "id": "p001", "name": "Participant 1" }
],
"custom_key_leads": [
{ "id": "l001", "name": "Lead 1" }
]
}