本产品主要用于验证用户身份证信息相关的真实性,包括姓名、生日和人脸比对的相似度。
API 方式
Base URL
印尼节点:https://id-credit.apitd.net/verification/kyc/idverifybiometric/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 分配 |
请求参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
id_number | String | 身份证件 ID 号码 | 必须 | 个人NIK号码。应为16位数字;不得为负数;不得为浮点数;不能为空;不得以0开头 |
name | String | 姓名 | 必须 | 姓名区分大小写,必须全部为大写字母。小写字母将无法匹配。 |
birth_date | String | 出生日期 | 必须 | YYYY-MM-DD格式 |
face_image | String | 人像照片 | 必须 | JPG、JPEG、PNG格式含人脸照的base64(NO WRAP),3M以内 |
country | String | 国家 | 必须 | 国家,必填. 两位国家码,符合 ISO 3166 标准。目前支持:印尼(ID) |
请求示例
{
"id_number":"5981314208283510000",
"name":"Joe",
"birth_date":"1997-01-01",
"face_image":"/9j/4AAQSkZJRgABAQAAeAB4AAD/********XLiqqauzsw1J3sf/2Q==",
"country":"ID"
}
响应参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
code | Integer | API 状态码 | 必须 | |
message | String | 状态信息 | 必须 | 在 API 异常状态下会输出具体的异常原因 |
sequence_id | String | 响应唯一码 | 必须 | 用于跟踪每次请求记录的唯一标识 |
result | String | 核验结果 | 必须 | 枚举值: 1. 通过:pass(姓名、生日和数据库都对应上,人脸相似度 ≥75) 2. 不通过:fail(姓名、生日与数据库不匹配,或人脸相似度 ≤75,其中任一条件不满足) |
id_name_match | String | ID和姓名是否匹配 | 必须 | 枚举值: 1. pass 2. fail 3. no_record |
id_birthdate_match | String | ID和生日是否匹配 | 必须 | 枚举值: 1. pass 2. fail 3. no_record |
face_similarity | Double | 人像对比的相似度 | 条件必须 | 范围 0 - 100,根据自身业务风险偏好,选择相似度阈值。TD建议结果≥75表示是同一个人 |
API状态码
code | Message | 含义 | 是否收费 |
---|---|---|---|
200 | success | 成功 | 是 |
301 | Service not purchased | 服务未购买 | 否 |
302 | Service has been suspend | 服务已被禁⽤ | 否 |
303 | Not enough balance | 流量不足 | 否 |
304 | Service expired | 服务已过期 | 否 |
305 | Daily maximum volume reached | 日流量已封顶 | 否 |
600 | Service Temporarily Unavailable | 服务超过限制 | 否 |
11301 | {parameter} empty | {参数}为空 | 否 |
11304 | The country partner located is not open | 国家不支持 | 否 |
11340 | {parameter} error | {参数}错误 | 否 |
11350 | Internal error | 系统错误 | 否 |
响应示例
- 业务成功示例(result=pass)
{
"code": 200,
"message": "Success",
"sequence_id": "170427842997****I3167369D6187177",
"result": "pass",
"id_name_match": "pass",
"id_birthday_match": "pass",
"face_similarity": 95.5
}
- 业务成功示例(result=fail,姓名不匹配)
{
"code": 200,
"message": "Success",
"sequence_id": "170427842997****I3167369D6187177",
"result": "fail",
"id_name_match": "fail",
"id_birthday_match": "pass",
"face_similarity": 95.5
}
- 业务成功示例(result=fail,数据库里无id number记录)
{
"code": 200,
"message": "Success",
"sequence_id": "170427842997****I3167369D6187177",
"result": "fail",
"id_name_match": "no_record",
"id_birthday_match": "no_record"
}
- 业务失败示例
{
"code": 11340,
"sequence_id": "170427842997****I3167369D6187177",
"message": "birth_date error"
}