Sign in

v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
CDD

Submit account KYC

Submit KYC information for the specified account.

post/open-api/v3/accounts/{accountId}/kyc

Path parameters

accountIdstring required

The UUID of the account.

Request body

firstNamestring required

User's first name. Example: John

lastNamestring required

User's last name. Example: Smith

dateOfBirthstring required

Date of birth in YYYY-MM-DD format. Example: 1990-01-01

gender'M' | 'F' required

User’s gender. Use "M" for male or "F" for female. Example: M

occupationstring

User's occupation code. Refer to the "Occupation Code" section on the top of the page for valid codes. Example: 11-1011

annualSalarystring

User’s annual salary. Example: 10000 USD

accountPurposestring

Purpose of the user's account. Example: Living Expense

expectedMonthlyVolumestring

Expected monthly spending. Example: 1000 USD

nationalitystring required

Two-letter country code of nationality, as defined in ISO 3166-1 alpha-2. Example: US

nationalIdstring required

ID number. Required for passport/driver’s license/national ID.

idType'CN-RIC' | 'PASSPORT' | 'HK-HKID' | 'DLN' | 'Government-Issued ID Card' | 'EU Residency Permit' | 'UAE Residency Permit' required

Type of ID.

ssnstring

9-digit SSN if the country is US. Example: 123456789

issueDatestring required

ID issue date in YYYY-MM-DD format. Example: 2018-05-10

expiryDatestring required

ID expiry date in YYYY-MM-DD format. Example: 2028-05-10

idFrontIdstring required

File ID of the front side of the ID document (from Upload files API).

idBackIdstring

File ID of the back side of the ID document (returned by the Upload files API). This field is not required for passports. For driver's licenses and non-mainland China ID cards, provide the back-side file ID if available; otherwise, reuse the front-side file ID.

selfiestring required

File ID of the applicant selfie (from Upload files API).

phoneNumberstring required

User's phone number without the country code, length ≤ 15. Example: 13800138000

phoneCountryCodestring required

The international dialing code of the user's mobile number, numbers only, no "+", length ≤ 3. Example: 86

sourceTypestring required

"api"

Example request

{
  "firstName": "John",
  "lastName": "Smith",
  "dateOfBirth": "1990-01-01",
  "occupation": "11-1011",
  "annualSalary": "10000 USD",
  "accountPurpose": "Living Expense",
  "expectedMonthlyVolume": "1000 USD",
  "nationality": "US",
  "ssn": "123456789",
  "issueDate": "2018-05-10",
  "expiryDate": "2028-05-10",
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "country": "US",
    "postalCode": "10001"
  },
  "phoneNumber": "1380013800",
  "phoneCountryCode": "86"
}

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter"
}