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

China：https://cn.apitd.net/verification/kyc/identity/v1

API

URL	Request Methods	Content-Type	Output Format	Character Set
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

Authentication

Parameter	Type	Description	Required/Optional	Notes
partner_code	String	Partner Code	required	assigned by TD
partner_key	String	Partner Key	required	assigned by TD

Request

Parameter	Type	Description	Required/Optional	Notes
scene	String	Scene Type	required	enumeration: name_id name_phone_id name_bank_card name_id_bank_card name_id_phone_bank_card
country	String	Country	required	2-letter country code according to ISO 3166
name	String	Name	conditionally required: required when this parameter is needed for verification
phone_number	String	Phone Number	conditionally required: required when this parameter is needed for verification	without '+ sign'
id_type	String	ID Type	conditionally required: required when this parameter is needed for verification	enumeration: national_id
id_number	String	ID Number	conditionally required: required when this parameter is needed for verification
bank_card_number	String	Bank Card Number	conditionally required: required when this parameter is needed for verification
face_image_type	String	Face Image Type	conditionally required: required when this parameter is needed for verification	enumeration: facial liveness id_image_hold
face_image	String	Face Image	conditionally required: required when this parameter is needed for verification	Base64 format
id_image	String	ID Card Portrait Page Image	conditionally required: required when this parameter is needed for verification
liveness_id	String	Unique ID for Liveness Detection	conditionally required: required when this parameter is needed for verification	when 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

Parameter	Type	Description	Required/Optional	Notes
code	Integer	API Status Code	required
message	String	Status Message	required	specific reasons will be provided if the API is abnormal
sequence_id	String	Unique ID of Response	required	A unique ID used to mark each request
result	String	Verification Result	required	enumeration: pass fail no_record
similarity	Integer	The Similarity of Portrait Comparison	conditionally required	Range 0 - 100, respond during portrait comparison

API Status Code

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

Respons Example

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