API Reference
English

KYC身份核验API

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

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
认证参数
字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段类型含义建议备注
sceneString场景模式必须枚举值:
姓名、身份证件号:name_id
姓名、手机号、身份证件号:name_phone_id
姓名、银行卡号:name_bank_card
姓名、身份证件号、银行卡号:name_id_bank_card
姓名、身份证件号、手机号、银行卡号:name_id_phone_bank_card
countryString国家必须两位国家码,符合 ISO 3166 标准
nameString核验人全名条件必须:若场景中有需要则必须
phone_numberString手机号 / 电话号码条件必须:若场景中有需要则必须不含 + 号和前缀
id_typeString身份证件 ID 类型条件必须:若场景中有需要则必须枚举值:
国民身份证:national_id
id_numberString身份证件 ID 号码条件必须:若场景中有需要则必须
bank_card_numberString银行卡号条件必须:若场景中有需要则必须
face_image_typeString人像照片类型条件必须:若场景中有需要则必须枚举值:
头像照片:facial
活体加密照片:liveness
手持身份证件人像页照片:id_image_hold
face_imageString人像照片条件必须:若场景中有需要则必须Base64 格式
id_imageString身份证件人像页照片条件必须:若场景中有需要则必须
liveness_idString活体检测的唯一 ID条件必须:若场景中有需要则必须何时传入:
活体检测
人像核验的时候需要对比的是活体照片

请求示例

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

响应参数

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

API 状态码

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

响应示例

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