| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-08-18 | v2.0.0 | 更新接口文档 |
一、 人像比对 v2.0
1.协议说明
2.请求参数
请求参数 Body 以 multipart/form-data 方式提交
3.响应参数说明
响应 body 数据为 JSON 格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 是否收费，1:收费；0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：021669111548844155 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| result | String | 返回结果，01--一致 02--不一致 03--库无 04--认证失败 （该字段不作为最终结果，具体核验结果请参考"idcardResult"、"photoResult"） |
| idcardResult | String | 身份证核验结果 01--一致 02--不一致 03--库无 04--认证失败 |
| idcardMessage | String | 身份证核验结果说明 |
| photoResult | String | 图像结果 01--判断为同一人 02--判断不是同一人 03--不能确定是否为同一人 04--认证失败 05--身份校验未通过 06--库中无照片 07--图片质量不合格,详情请联系管理员 08--库中无此号 09-无法验证 |
| photoMessage | String | 图像结果说明 |
| photoScore | String | 照片相似的分数(0-100)，查询中心分值：中心的人像我司提供的建议范围为 0-40 分为不同人，40-60 分为不确定，60-100 为同一人。注：可以根据自己的使用场景对错误率的敏感度，通过返回的相似度得分，自行调整置信区间，已达到合适的判断效果 |
4.响应返回实体 DEMO
{
"chargeStatus": 1,
"message": "成功",
"data": {
"orderNo": "021669111548844155",
"handleTime": "2022-11-22 18:05:48",
"result": "01",
"idcardResult": "01",
"idcardMessage": "一致",
"photoResult": "01",
"photoMessage": "判断为同一人",
"photoScore": "95"
},
"code": "200000"
}
5.失败返回实体
{
"chargeStatus": 0,
"message": "系统错误",
"data": {
"orderNo": "011669111884860823",
"handleTime": "2022-11-22 18:11:24",
"result": "04",
"idcardResult": "04",
"idcardMessage": "认证失败，请联系管理员",
"photoResult": "07",
"photoMessage": "图片质量不合格,详情请联系管理员",
"photoScore": ""
},
"code": "500000"
}
6.result对应关系
| idcardresult | photoresult | result |
|---|
| 01— 一致 | 01— 一致 | 01—判断为同一人 |
| 02—不 一致 | 05— 身份证校验未通过 | 02—判断不是同一人 |
| 01— 一致 | 03—不能确定是否为同一人 | 01— 一致 |
| 01— 一致 | 04—认证失败 | 01— 一致 |
| 01— 一致 | 06—库中无照片 | 01— 一致 |
| 01— 一致 | 02—不一致 | 01— 一致 |
| 03—无记录 | 08—库中无此号 | 03—无记录 |
| 04—认证失败，照片不合格 | 07—图片质量不合格,详情请联系管理员 | 04—认证失败，照片不合格 |
| 01— 一致 | 09-无法验证 | 01— 一致 |
二、 涉外人像比对
1.协议说明
2.请求参数：
请求参数Body以multipart/form-data方式提交
| 参数名 | 类型 | 是否必填 | 说明 |
|---|
| appId | String | 是 | 请在https://www.chuanglan.com/登录后获取 |
| appKey | String | 是 | 请在https://www.chuanglan.com/登录后获取 |
| image | String | 是 | 人脸照，base64字符串，图片大小不能大于50K，base64字符串去掉头部描述(如data:image/png;base64,) |
| idNum | String | 是 | 证件号 |
| name | String | 是 | 姓名 |
| nation | String | 是 | 国籍(三字码,如:中国,三字码为：CHN) |
| type | String | 是 | 证件类型 414:华侨护照 516:港澳居民来往内地通行证 511:台湾居民来往大陆通行 553:外国人永久居留证 |
3.请求参数示例
| 参数名 | 参数值 |
|---|
| appId | abcdef |
| appKey | 123456 |
| image | /9j/4AAQSkZJRgABAQAAAQABAAD...... |
| idNum | USA371517081101 |
| name | BROCK,EUNICE |
| nation | USA |
| type | 553 |
4.返回参数字段，数据是JSON格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 是否收费，枚举值：1 ：收费 0：不收费 |
| code | String | 响应code码。200000：成功500000: 失败 |
| message | String | 响应code码解释 |
| data | Object | 返回对象 |
| +orderNo | String | 业务唯一流水号 |
| +handleTime | String | 处理时间 |
| +result | String | 最终返回结果，01--一致 02--不一致 03--库无 04--认证失败 |
| +idcardResult | String | 身份证核验结果 01--一致 02--不一致 03--库无 04--认证失败 |
| +idcardMessage | String | 身份证核验结果说明 |
| +photoResult | String | 图像结果
01--判断为同一人
02--判断不是同一人
03--不能确定是否为同一人
04--认证失败
05--身份校验未通过
06--库中无照片
07--图片质量不合格,详情请联系管理员
08--库中无此号
09-无法验证 |
| +photoMessage | String | 图像结果说明 |
5.调用涉外人像比对正常示例：
{
"chargeStatus": 1,
"message": "成功",
"data": {
"orderNo": "011702264341100001",
"handleTime": "2023-12-11 11:12:22",
"result": "01",
"idcardResult": "01",
"idcardMessage": "一致",
"photoResult": "01",
"photoMessage": "判断为同一人"
},
"code": "200000"
}
三、 人像比对 v3.0
1.协议说明
2.请求参数
请求参数 Body 以 multipart/form-data 方式提交
3.响应参数说明
响应 body 数据为 JSON 格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 是否收费，1:收费；0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：628291418130630 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| resultData | Object | |
| verification_code | String | 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 |
| verification_result | String | 审核校验信息，具体参考 表1 验证信息 |
| verification_message | String | 审核校验代码，具体参考 表1 验证信息 |
| similarity | String | 人像相识度，取值范围为[0,1000]。 |
4.响应返回实体 DEMO
{
"chargeStatus": 1,
"message": "成功",
"data": {
"orderNo": "011712634409100001",
"handleTime": "2024-04-09 11:46:49",
"resultData": {
"verification_code": 1000,
"verification_result": "valid",
"verification_message": "Successful certification",
"similarity": "894.07"
}
},
"code": "200000"
}
5.5. 响应不一致返回实体DEMO
{
"chargeStatus": 0,
"message": "成功",
"data": {
"orderNo": "011712633277100049",
"handleTime": "2024-04-09 11:27:57",
"resultData": {
"verification_code": 2001,
"verification_result": "invalid",
"verification_message": "Inconsistent identity information",
"similarity": "0"
}
},
"code": "200000"
}
关于 verification_code 验证信息
| 检验代码 | 检验结果 | 检验信息 | 说明 | 收费 |
|---|
| 1000 | valid | Successful certification | | 认证成功 |
| 2001 | nvalid | Inconsistent identity information | 认证信息不一致，即姓名与身份证号码不一致 | 否 |
| 2002 | nvalid | Inconsistent face information | 人脸与身份证信息不符 | 是 |
| 2003 | nvalid | Face image quality or format problem | 人脸图像质量或格式问题 | 是 |
| 2006 | nvalid | Id card photo does not exist | 证件照不存在，属于数据源问题（极少出现这种情况） | 否 |
| 3001 | nonexistent | Nonexistent identity information | 认证中心数据源无此身份证信息，可能原因是被验证人正在办理户籍迁移，或者被验证人是军人或政要 | 否 |
生僻字识别不成功说明
由于历史原因，公安部门在办理身份证登记身份信息时，使用了微软或其他输入法，将生僻字以PUA编码形式记录在了公安数据库中。
随着信息化发展，这些生僻字以新的编码被国家标准GB18030收录。如今，在手机及通用计算机上都是使用新的编码输入和显示这些生僻字，
但由于实名认证时公安系统是根据汉字编码进行比较，而这些生僻字PUA编码和GB18030编码并不一致，所以核验不会通过。
解决方案：
- 通过第三方网站提供的生僻字查询功能，传入生僻字以其他方式编码的姓名进行核验（https://name.vurls.cn/ui/index/uigen/）。
- 以更正信息为由到公安机关申请换证，以新的通用编码重新录入姓名。
code码解释
没有更多了
