Skip to main content

User Kyc Info

is used query kyc information

Request address

  • API Address (requestURI) : /openapi/v1/kyc/third/query/user/verify

Request parameters

Parameter nameTypeRequirementDescription
uidStringRUser ID

Sample request

{
"uid": "66434a76af1c4f6486e5505bc0816d5c"
}

Response parameters

Parameter nameTypeRequirementDescription
uidStringOUser ID
referenceStringOUnique ID for the current user-initiated audit request
statusStringOStatus: 0 for not authenticated, 1 for authentication in progress, 2 for approved, 3 for declined, 4 for canceled authentication
declinedInfoStringOReason for failure in English
ifChargeStringO
faceStringOMatch between live image and document
ethnicityStringOEthnicity
addressStringOAddress
fullNameStringOFull name
documentNumberStringODocument number
dobStringODate of birth
genderStringOGender
documentCountryStringOCountry name on the document, e.g., China
documentCountryCodeStringOCountry code on the document, e.g., CN
documentOfficialNameStringOOfficial document name, e.g., Resident Identity Card
documentTypeStringO
firstNameStringO
lastNameStringO
countryStringOFull country name, e.g., People's Republic of China
issueDateStringOIssue date of the document
expiryDateStringOExpiry date of the document
authorityStringOIssuing authority of the document, typically a local public security bureau in China
idFrontUrlStringOURL of the front side of the document on OSS
idBackUrlStringOURL of the back side of the document on OSS
driverFrontUrlStringOURL of the front side of the driver's license on OSS
driverBackUrlStringOURL of the back side of the driver's license on OSS
passportUrlStringOURL of the passport on OSS
faceUrlStringOURL of the live image on OSS
fullNameNativeStringOCorresponding native field for full name
firstNameNativeStringOCorresponding native field for first name
lastNameNativeStringOCorresponding native field for last name
dobNativeStringOCorresponding native field for date of birth
genderNativeStringOCorresponding 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
}