Identity verification sharing
Interface address: /api/v1/user/kyc/share
Note: This interface allows you to send users' identity verification information to MultiExchange.
Request input parameters
Parameter | Type | Mandatory | Description |
---|---|---|---|
String | Y | Merchant user ID and email | |
kycType | String | Y | Identity verification type. For individual: USER. For enterprise: ENTERPRISE |
registerTime | String | N | Account sign-up time (yyyy-MM-dd HH:mm:ss) |
kycIdentityInfoVo | Object | Y | Identity verification details |
type | String | N | If not provided, this field will be deemed as "new" or "update" by default. new: Create new users and sync (the data) to "complytek". update: Update the details of an existing user and sync (the data) to "complytek". If the status remains unchanged, the merchant does not need to be notified. reNew: Update user identity verification information after a reset. In this case, the merchant need to be notified of the user status. |
callbackUrl | String | N | Webhook push address. Preferred for pushing user status. If the merchant does not provide this parameter, the default callback URL configured by the merchant will be used by default. |
KycIdentityInfoVo
Parameter | Type | Mandatory | Description |
---|---|---|---|
firstName | String | Y | First name |
middleName | String | N | Middle name |
lastName | String | Y | Last name |
firstNameEn | String | N | First name in English |
middleNameEn | String | N | Middle name in English |
lastNameEn | String | N | Last name in English |
gender | String | Y | Gender (Male: M. Female: F) |
idType | String | Y | Identity document type: PASSPORT, DRIVERS, VISA, ID_CARD, RESIDENCE_PERMIT, UTILITY_BILL |
idNumber | String | Y | ID number |
nationality | String | Y | Nationality (3-digit country code in ISO 3166-1) |
residentialCountry | String | Y | Country/region of residence (3-digit country code in ISO 3166-1) |
idCountry | String | Y | Country of ID issuance (3-digit country code in ISO 3166-1) |
dob | String | Y | Date of birth |
idExpiry | String | Y | Expiration date of ID document |
street | String | N | Street name |
number | String | N | Door number |
district | String | N | District |
city | String | N | City |
state | String | N | State |
zip | String | N | Postal code |
address | String | N | Residential address |
frontFileUrl | String | Y | Front image URL of the document (URL obtained upon uploading identity verification documents) |
backFileUrl | String | N | Back image URL of the document (URL obtained upon uploading identity verification documents) |
selfieFileUrl | String | Y | URL to user photo (URL obtained upon uploading identity verification documents) |
amlFileUrl | String | N | User's AML report (URL obtained upon uploading identity verification documents) |
kycTime | String | N | Identity verification date/time (yyyy-MM-dd HH:mm:ss) |
kycLevel | String | Y | Identity verification level (L0: not verified. L1: Face + document + liveness detection L2: Face + document + liveness detection + proof of residential address + proof of income) |
accountPurpose | String | N | User purposes. |
monthSpend | String | N | Monthly user spending. |
sourceFunds | String | N | Source of funds. |
occupation | String | N | Occupation. |
Output parameters
Parameter | Type | Mandatory | Description |
---|---|---|---|
userId | String | Y | User's unique tag on MultiExchange |