KYC China
Endpoints
Client ID in x-client-id header.
Client Secret in x-client-secret header.
The verification method to use:
two-factor: Verify name matches ID numberfour-factor: Verify name, ID number, and ID card validity datesimage: Verify name, ID number, and compare facial photoname-mobile: Verify mobile number is registered to this nameid-mobile: Verify mobile number is registered to this ID numberthree-factor: Verify mobile, name, and ID number all match
two-factorPossible values: Full legal name in Chinese characters.
Required for two-factor, four-factor, image, name-mobile, three-factor.
李明18-digit Chinese Resident Identity Card number.
Required for two-factor, four-factor, image, id-mobile, three-factor.
110101199003076515Pattern: ^[0-9]{17}[0-9Xx]$11-digit Chinese mobile phone number.
Required for name-mobile, id-mobile, three-factor.
13912345678Pattern: ^1[3-9][0-9]{9}$ID card issue date in YYYYMMDD format.
Required when type is four-factor.
20200315Pattern: ^[0-9]{8}$ID card expiry date in YYYYMMDD format, or "长期" for permanent validity.
Required when type is four-factor.
20400315Base64-encoded facial photograph for biometric comparison.
Required when type is image.
Supported formats: JPEG, PNG. Recommended size: 300x400 pixels minimum.
Identity verification completed
Whether the verification request was processed successfully
trueWhether the provided information matches records.
true: Information matchesfalse: Information does not matchnull: Unable to verify (no records found)
trueRaw verification result code ("1" = match, "-1" = no match)
1Human-readable description of the verification result
Identity information matchesInvalid request parameters
Upstream verification service error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Lookup type:
attribution: Look up carrier and location infolocation-verify: Check distance between mobile location and an addresslocation-query: Get the city where the user is located
attributionPossible values: 11-digit Chinese mobile phone number
13912345678Pattern: ^1[3-9][0-9]{9}$Location category. Required for location-verify and location-query.
1: Common location (highest activity) —location-verifyonly2: Work location (7:00-19:00 weekdays)3: Residential location (21:00-07:00)
2Possible values: City name in Chinese. Required for location-verify.
北京Full street address in Chinese. Required for location-verify.
朝阳区建国路88号Mobile lookup completed
Invalid request parameters
Upstream verification service error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Risk check type:
anti-fraud: Fraud/gambling risk score (requiresmobileand/oridNo)police: Police blacklist check (requiresnameandidNo)
anti-fraudPossible values: 11-digit Chinese mobile phone number.
Used by anti-fraud. At least one of mobile or idNo required.
13912345678Pattern: ^1[3-9][0-9]{9}$18-digit Chinese Resident Identity Card number.
Required for police. Optional for anti-fraud.
110101199003076515Pattern: ^[0-9]{17}[0-9Xx]$Full legal name in Chinese characters.
Required for police.
李明Risk check completed
Invalid request parameters
Upstream verification service error
Last updated

