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 | User’s 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 | Encrypted | Description |
|---|---|---|---|---|
| firstName | String | N | Y | First name |
| middleName | String | N | Y | Middle name |
| lastName | String | N | Y | Last name |
| firstNameEn | String | N | Y | First name in English |
| middleNameEn | String | N | Y | Middle name in English |
| lastNameEn | String | N | Y | Last name in English |
| gender | String | Y | Y | Gender (Male: M. Female: F) |
| idType | String | Y | Y | Identity document type: PASSPORT, DRIVERS, VISA, ID_CARD, RESIDENCE_PERMIT, UTILITY_BILL |
| idNumber | String | Y | Y | ID number |
| nationality | String | N | Y | Nationality (3-digit country code in ISO 3166-1) |
| residentialCountry | String | N | Y | Country/region of residence (3-digit country code in ISO 3166-1) |
| idCountry | String | Y | Y | Country of ID issuance (3-digit country code in ISO 3166-1) |
| dob | String | Y | Y | Date of birth |
| idExpiry | String | Y | Y | Expiration date of ID document |
| street | String | N | Y | Street name |
| number | String | N | Y | Door number |
| district | String | N | Y | District |
| city | String | N | Y | City |
| state | String | N | Y | State |
| zip | String | N | Y | Postal code |
| address | String | N | Y | Residential address |
| frontFileUrl | String | Y | Y | Front image URL of the document (URL obtained upon uploading identity verification documents) |
| backFileUrl | String | N | Y | Back image URL of the document (URL obtained upon uploading identity verification documents) |
| selfieFileUrl | String | Y | Y | URL to user photo (URL obtained upon uploading identity verification documents) |
| amlFileUrl | String | N | Y | User's AML report (URL obtained upon uploading identity verification documents) |
| kycTime | String | N | Y | Identity verification date/time (yyyy-MM-dd HH:mm:ss) |
| kycLevel | String | Y | 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 | Y | User purposes. |
| monthSpend | String | N | Y | Monthly user spending. |
| sourceFunds | String | N | Y | Source of funds. |
| occupation | String | N | Y | Occupation. |
Output parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| userId | String | Y | User's unique tag on MultiExchange |