{
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
{
"message": "success",
"data": {
"id": "cust-001",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
}
{
"error": "kyc already exists",
"error_code": "KYC_ALREADY_EXISTS",
"message": "A KYC record with this id already exists"
}
Partner Customer KYC
Create Customer KYC
Create a partner customer KYC record.
POST
/
partners
/
kycs
/
{id}
{
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
{
"message": "success",
"data": {
"id": "cust-001",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
}
{
"error": "kyc already exists",
"error_code": "KYC_ALREADY_EXISTS",
"message": "A KYC record with this id already exists"
}
Create a partner customer KYC record. The path
{id} is the partner-provided KYC id, later referenced as kyc_id on onramp, offramp, and withdraw orders. Fails with 409 Conflict if a record with that id already exists.
See the Partner Customer KYC guide for the field reference and required-field rules.
Authentication
string
required
Your partner app key.
string
required
Base64-encoded Ed25519 signature of the sign data.
string
required
Unix timestamp (seconds) of the request. Must be within 60 seconds of server time.
Path Parameters
string
required
Partner-provided unique id for this customer. Use this value as
kyc_id on subsequent orders.Body Parameters
At least one of
email or phone must be provided. date_of_expiry is optional. Every other body field is mandatory.string
required
Full name.
string
Email. Required if
phone is not provided.string
Phone number. Required if
email is not provided.string
required
Residential address.
string
required
Identity document number.
integer
required
1 = Citizen ID, 2 = Passport, 3 = Driver License.integer
required
1 = Male, 2 = Female, 3 = Other.string
required
Nationality.
string
required
Identity document issue date in ISO
YYYY-MM-DD format.string
Optional. Identity document expiry date in ISO
YYYY-MM-DD format. Omit when the document does not expire.{
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
{
"message": "success",
"data": {
"id": "cust-001",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+84123456789",
"address": "123 Le Loi, District 1, Ho Chi Minh City",
"id_number": "012345678",
"id_type": 1,
"sex": 2,
"nationality": "VN",
"date_of_issue": "2020-01-01",
"date_of_expiry": "2030-01-01"
}
}
{
"error": "kyc already exists",
"error_code": "KYC_ALREADY_EXISTS",
"message": "A KYC record with this id already exists"
}