身份证识别
一、接口描述
1. 功能描述
中国身份证正反面识别,支持2.8万生僻字，支持所有双语版式的身份证结构化识别
2. 接口数据要求：
- 图片格式:base64编码
- 图片类型: jpg/jpeg/png
- 图片大小: 小于5M
3. 接口使用：
平台为每个API提供试用体验服务，您在AI市场选择“免费试用”规格下单后，即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制，如需更高性能的API服务，可以提交咨询工单，联系京东AI扩容购买。
在获得使用权限后，您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发，整体流程详见 接入流程
用户需要使用图片base64编码去做请求，使用其他图片的base64编码请求成功时也会加入计费。
二、请求说明
1. 接口地址 ：
https://aiapi.jd.com/jdai/ocr_idcard_new
2. 请求方式：
post
3. 请求参数
（1）query请求参数
公共请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| appkey | String | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey，可在买家中心控制台中获取 |
| timestamp | long | 是 | 1541491668060 | 请求的时间戳，精确到毫秒，timestamp有效期5分钟 |
| sign | String | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名，根据规则MD5(sectetkey+timestamp) |
（2）header请求参数
业务请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Content-Type | String | 是 | application/json | 标准编码格式 |
（3）body请求参数
业务请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| businessId | String | 是 | "JDT-NUEHUB-COM-FACE" | 固定值 |
| appName | String | 是 | "FACE_ALGORITHM" | 固定值 |
| appAuthorityKey | String | 是 | "sADsk3+58E9yf/fUN9DmBA==" | 固定值 |
| idcardType | String | 是 | "N" | 身份证正反面，正面”P“，反面”N“，未知"UN_KNOW" |
| idcardItem | ImageItem | 是 | {...} | 身份证图片 |
| serialNo | String | 是 | "1621270610624-010221159145-1821391" | 随机唯一 |
参数ImageItem说明，imgBase64、imgArr、imgUrl三选一
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| encryptionType | String | 是 | "NON" | 指定图片加密方式 |
| imgBase64 | String | 是 | 图像Base64编码值，去掉图片头"data:image/png;base64,"， media_id=4AAQSk...（由于过长，不给出示例） | 图片base64编码 |
| imgArr | byte[] | 否 | 图像byte[]数组 | 图像byte[]数组 |
| imgUrl | String | 否 | 图像URL地址 | 图像URL地址 |
| imgType | String | 是 | IDN | 图片类型IDP(身份证正面),IDN(身份证反面), |
（4）请求代码示例
建议您使用我们提供的SDK进行调用，SDK获取及调用方式详见本页一接口描述中的2接口使用
三、返回说明
1.返回参数
（1）公共返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | string | 1000 | 参见下方错误码-系统级错误码 |
| charge | boolean | false 或 true | false：不扣费， true：扣费 |
| remainTimes | long | 1305 | 剩余调用次数；免费api：每天剩余调用次数；收费api：剩余次数；无限制时为-1 |
| remainSeconds | long | 1223456 | 剩余调用时间（s）；免费api：-1；收费api：剩余调用时间；无限制时为-1 |
| msg | string | 查询成功 | 参见下方错误码-系统级错误码 |
| result | object | {...} | 查询结果 |
（2）业务返回参数
result参数信息
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | number | 0 | 状态code |
| serialNo | string | 98a39e53-84d4-448e-9081-29f64a6cd984 | 请求id |
| msg | string | success | 返回信息 |
| idCardBackInfo | Object | {...} | 身份证反面识别结果 |
| idCardInfo | Object | {...} | 身份证正面识别结果 |
| extMap | Object | {..} | 扩展信息 |
idCardBackInfo字段说明
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| issuingAuthority | string | 北京公安局 | 签证机关 |
| overdue | boolean | false | 是否过期 |
| expirationDateStr | string | 长期 | 过期时间 |
| singDateStr | string | 2007-10-19 | 签发时间 |
| singDate | string | 1192723200000 | 签发时间 |
idCardInfo字段说明
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| name | string | 张三 | 姓名 |
| cardNo | string | 110111202301014569 | 身份证号码 |
| sex | string | 男 | 性别 |
| brith | string | 20230101 | 生日 |
| address | string | 北京市大兴区 | 户籍地址 |
| nation | string | 汉 | 民族 |
extMap字段说明
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| idCardUrl | string | IDCARD_202124W_66801d604491234 | idcardType = P 时 身份证正面url |
| idCardBackUrl | string | IDCARD_202124W_6680456604496a8d4 | idcardType = N 时 身份证反面url |
| cardUrl | string | IDCARD_202124W_6680456604496a8d4 | idcardType = UN_KNOW时 身份证url |
2.返回示例
{
"msg":"成功",
"extMap":{
"idCardBackUrl":"IDCARD_202124W_66801d604496a8d4"
},
"code":0,
"idCardBackInfo":{
"issuingAuthority":"瑞安市公安局",
"overdue":false,
"expirationDateStr":"长期",
"singDateStr":"2007-10-19",
"singDate":1192723200000,
"class":"com.jd.jr.facecloud.common.export.dto.idcard.IDCardBackInfo"
},
"class":"com.jd.jr.face.business.platfrom.exprot.dto.resp.idcard.IDCardOcrRecognitionResp",
"timestamp":1623305379944,
"serialNo":"1623305379427-010222082083-183169"
}
四、错误码信息
1.系统级错误码
2.业务错误码
| 业务错误码（code） | message | 说明 |
|---|---|---|
| 10 | "权限受限!" | 参数错误 |
| 22500100 | "身份证识别异常, 请重试!" | 识别失败 |
| 50 | "系统错误!" | 系统异常 |