API Reference
中文

KYC Identity Verification API

The KYC Identity Verification API is used to verify the authenticity of user identity-related information, including but not limited to name, mobile phone number, ID card, bank card, etc.

API Method

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
Authentication
ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner Coderequiredassigned by TD
partner_keyStringPartner Keyrequiredassigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
sceneStringScene Typerequiredenumeration:
name_id
name_phone_id
name_bank_card
name_id_bank_card
name_id_phone_bank_card
countryStringCountryrequired2-letter country code according to ISO 3166
nameStringNameconditionally required: required when this parameter is needed for verification
phone_numberStringPhone Numberconditionally required: required when this parameter is needed for verificationwithout '+ sign'
id_typeStringID Typeconditionally required: required when this parameter is needed for verificationenumeration:
national_id
id_numberStringID Numberconditionally required: required when this parameter is needed for verification
bank_card_numberStringBank Card Numberconditionally required: required when this parameter is needed for verification
face_image_typeStringFace Image Typeconditionally required: required when this parameter is needed for verificationenumeration:
facial
liveness
id_image_hold
face_imageStringFace Imageconditionally required: required when this parameter is needed for verificationBase64 format
id_imageStringID Card Portrait Page Imageconditionally required: required when this parameter is needed for verification
liveness_idStringUnique ID for Liveness Detectionconditionally required: required when this parameter is needed for verificationwhen to transfer:
Liveness Detection
liveness image need to checked during the verification

Request Example

{
    "scene": "name_phone",
    "country": "FR",
    "name": "PierreZB",
    "phone_number": "659486701",
    "id_type": "national_id",
    "id_number": "xxxxxxxxxx",
    "bank_card_number": "xxxxxx"
}

Response Parameter

ParameterTypeDescriptionRequired/OptionalNotes
codeIntegerAPI Status Coderequired
messageStringStatus Messagerequiredspecific reasons will be provided if the API is abnormal
sequence_idStringUnique ID of ResponserequiredA unique ID used to mark each request
resultStringVerification Resultrequiredenumeration:
pass
fail
no_record
similarityIntegerThe Similarity of Portrait Comparisonconditionally requiredRange 0 - 100, respond during portrait comparison

API Status Code

codeDescription
200Success
301Service not purchased
302Traffic blocked
303Traffic insufficient
304Service expired
305Daily maximum volume reached
9050{parameter} empty or error
9059System error

Respons Example

{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": "pass"
}