KYC身份核验API

KYC 身份核验 API 是用于验证用户身份相关信息的真实性，包括但不限于姓名、手机号、身份证件、银行卡等。

API 方式

Base URL

中国节点：https://cn.apitd.net/verification/kyc/identity/v1

API

URL	请求方式	Content-Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由 TD 分配
partner_key	String	合作方密钥	必须	由 TD 分配

请求参数

字段	类型	含义	建议	备注
scene	String	场景模式	必须	枚举值：姓名、身份证件号：name_id 姓名、手机号、身份证件号：name_phone_id 姓名、银行卡号：name_bank_card 姓名、身份证件号、银行卡号：name_id_bank_card 姓名、身份证件号、手机号、银行卡号：name_id_phone_bank_card
country	String	国家	必须	两位国家码，符合 ISO 3166 标准
name	String	核验人全名	条件必须：若场景中有需要则必须
phone_number	String	手机号 / 电话号码	条件必须：若场景中有需要则必须	不含 + 号和前缀
id_type	String	身份证件 ID 类型	条件必须：若场景中有需要则必须	枚举值：国民身份证：national_id
id_number	String	身份证件 ID 号码	条件必须：若场景中有需要则必须
bank_card_number	String	银行卡号	条件必须：若场景中有需要则必须
face_image_type	String	人像照片类型	条件必须：若场景中有需要则必须	枚举值：头像照片：facial 活体加密照片：liveness 手持身份证件人像页照片：id_image_hold
face_image	String	人像照片	条件必须：若场景中有需要则必须	Base64 格式
id_image	String	身份证件人像页照片	条件必须：若场景中有需要则必须
liveness_id	String	活体检测的唯一 ID	条件必须：若场景中有需要则必须	何时传入：活体检测人像核验的时候需要对比的是活体照片

请求示例

{
    "scene": "name_phone",
    "country": "CN",
    "name": "张三",
    "phone_number": "18700001111",
    "id_type": "national_id",
    "id_number": "xxxxxxxxxx",
    "bank_card_number": "xxxxxx"
}

响应参数

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	必须	用于跟踪每次请求记录的唯一标识
result	String	核验结果	必须	枚举值：通过：pass 不通过：fail 无纪录：no_record
similarity	Integer	人像对比的相似度	条件必须	范围 0 - 100 ，只在有人像对比的场景中返回

API 状态码

code	含义
200	成功
301	未购买此服务
302	流量已被禁用
303	流量不足
304	服务已过期
305	日流量已封顶
9050	{字段名}为空或错误
9059	系统异常

响应示例

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