API Reference
English

身份验真Dukcapil-印尼

本产品主要用于验证用户身份证信息相关的真实性,包括姓名、生日和人脸比对的相似度。

API 方式

Base URL

印尼节点:https://id-credit.apitd.net/verification/kyc/idverifybiometric/v1

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

认证参数

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

请求参数

字段类型含义建议备注
id_numberString身份证件 ID 号码必须个人NIK号码。应为16位数字;不得为负数;不得为浮点数;不能为空;不得以0开头
nameString姓名必须姓名区分大小写,必须全部为大写字母。小写字母将无法匹配。
birth_dateString出生日期必须YYYY-MM-DD格式
face_imageString人像照片必须JPG、JPEG、PNG格式含人脸照的base64(NO WRAP),3M以内
countryString国家必须国家,必填. 两位国家码,符合 ISO 3166 标准。目前支持:印尼(ID)

请求示例

{
    "id_number":"5981314208283510000",
    "name":"Joe",
    "birth_date":"1997-01-01",
    "face_image":"/9j/4AAQSkZJRgABAQAAeAB4AAD/********XLiqqauzsw1J3sf/2Q==",
    "country":"ID"
}

响应参数

字段类型含义建议备注
codeIntegerAPI 状态码必须
messageString状态信息必须在 API 异常状态下会输出具体的异常原因
sequence_idString响应唯一码必须用于跟踪每次请求记录的唯一标识
resultString核验结果必须枚举值:

1. 通过:pass(姓名、生日和数据库都对应上,人脸相似度 ≥75)
2. 不通过:fail(姓名、生日与数据库不匹配,或人脸相似度 ≤75,其中任一条件不满足)
id_name_matchStringID和姓名是否匹配必须枚举值:

1. pass
2. fail
3. no_record
id_birthdate_matchStringID和生日是否匹配必须枚举值:

1. pass
2. fail
3. no_record
face_similarityDouble人像对比的相似度条件必须范围 0 - 100,根据自身业务风险偏好,选择相似度阈值。TD建议结果≥75表示是同一个人

API状态码

codeMessage含义是否收费
200success成功
301Service not purchased服务未购买
302Service has been suspend服务已被禁⽤
303Not enough balance流量不足
304Service expired服务已过期
305Daily maximum volume reached日流量已封顶
600Service Temporarily Unavailable服务超过限制
11301{parameter} empty{参数}为空
11304The country partner located is not open国家不支持
11340{parameter} error{参数}错误
11350Internal 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"
}