User Kyc Info
is used query kyc information
Request address
- API Address (requestURI) : /openapi/v1/kyc/third/query/user/verify
Request parameters
| Parameter name | Type | Requirement | Description |
|---|---|---|---|
| uid | String | R | User ID |
Sample request
{
"uid": "66434a76af1c4f6486e5505bc0816d5c"
}
Response parameters
| Parameter name | Type | Requirement | Description |
|---|---|---|---|
| uid | String | O | User ID |
| reference | String | O | Unique ID for the current user-initiated audit request |
| status | String | O | Status: 0 for not authenticated, 1 for authentication in progress, 2 for approved, 3 for declined, 4 for canceled authentication |
| declinedInfo | String | O | Reason for failure in English |
| ifCharge | String | O | |
| face | String | O | Match between live image and document |
| ethnicity | String | O | Ethnicity |
| address | String | O | Address |
| fullName | String | O | Full name |
| documentNumber | String | O | Document number |
| dob | String | O | Date of birth |
| gender | String | O | Gender |
| documentCountry | String | O | Country name on the document, e.g., China |
| documentCountryCode | String | O | Country code on the document, e.g., CN |
| documentOfficialName | String | O | Official document name, e.g., Resident Identity Card |
| documentType | String | O | |
| firstName | String | O | |
| lastName | String | O | |
| country | String | O | Full country name, e.g., People's Republic of China |
| issueDate | String | O | Issue date of the document |
| expiryDate | String | O | Expiry date of the document |
| authority | String | O | Issuing authority of the document, typically a local public security bureau in China |
| idFrontUrl | String | O | URL of the front side of the document on OSS |
| idBackUrl | String | O | URL of the back side of the document on OSS |
| driverFrontUrl | String | O | URL of the front side of the driver's license on OSS |
| driverBackUrl | String | O | URL of the back side of the driver's license on OSS |
| passportUrl | String | O | URL of the passport on OSS |
| faceUrl | String | O | URL of the live image on OSS |
| fullNameNative | String | O | Corresponding native field for full name |
| firstNameNative | String | O | Corresponding native field for first name |
| lastNameNative | String | O | Corresponding native field for last name |
| dobNative | String | O | Corresponding native field for date of birth |
| genderNative | String | O | Corresponding native field for gender |
Sample response
{
"code": "0",
"msg": "ok",
"data": {
"uid": "1854787283891798018",
"reference": null,
"status": "2",
"declinedInfo": null,
"ifCharge": "1",
"face": "93",
"ethnicity": "汉",
"address": "河南省**市**区****号",
"fullName": "**乐",
"documentNumber": "4115**********29034",
"dob": "19890202",
"gender": "男",
"documentCountry": null,
"documentCountryCode": null,
"documentOfficialName": null,
"documentType": "00860000001",
"firstName": null,
"lastName": null,
"country": null,
"issueDate": null,
"expiryDate": "20191122-20391122",
"authority": null,
"idFrontUrl": null,
"idBackUrl": null,
"driverFrontUrl": null,
"driverBackUrl": null,
"passportUrl": null,
"faceUrl": null,
"fullNameNative": "**乐",
"firstNameNative": null,
"lastNameNative": null,
"dobNative": "19890202",
"genderNative": "男"
},
"success": true
}