身份证识别
一、接口描述
1. 功能描述
天壤智能身份证识别,是天壤OCR产品之一。支持识别身份证正反面信息包括姓名、性别、民族、出生日期、住址、身份证号等关键字段高精度识别,支持正、反双面的分类和识别,支持少数民族、生僻字、角度偏转等场景下的秒级识别,支持复杂场景手机拍照件及背景图片干扰下的身份证识别。身份证识别准确率达98%以上,基于场景数据训练后准确率可以持续迭代和提升。
2. 接口数据要求
- 图片格式:base64编码
- 图片类型: jpg/jpeg/png
- 图片大小: 小于5M
- 若图片过大,建议使用压缩率较大的格式
3. 接口使用:
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程。用户需要使用营业执照图片base64编码去做请求,使用其他图片的base64编码请求成功时也会加入计费。
二、请求说明
1. 接口地址:
https://aiapi.jd.com/tianrang/idcard
2. 请求方式
POST
3. 请求参数
(1)query请求参数
公共请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
appkey |
String |
是 |
21d2b762ecb86593f9668526920f46c |
您的appkey,可在买家中心控制台中获取 |
timestamp |
long |
是 |
1541491668961 |
请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign |
String |
是 |
6e148773a0337a8f2200ba90d445f083 |
签名,根据规则MD5(sectetkey+timestamp) |
名称 |
类型 |
必填 |
示例值 |
描述 |
Content-Type |
String |
true |
application/x-www-form-urlencoded |
标准编码格式 |
(3)body请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
media_id |
string |
true |
图像Base64编码值,去掉图片头"data:image/png;base64,", media_id=4AAQSk...}(由于过长,不给出示例) |
图片base64编码 |
(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)业务返回参数
名称 |
类型 |
示例值 |
描述 |
code |
number |
0 |
状态code |
requestId |
String |
98a39e53-84d4-448e-9081-29f64a6cd984 |
请求id |
message |
String |
success |
返回信息 |
data |
Object |
{...} |
data |
data字段说明
身份证信息面
名称 |
类型 |
示例值 |
描述 |
class_name |
string |
idcard_info |
类别-身份证信息面 |
address |
string |
江西省新余市渝水区长青中路6号5栋3单元2楼19号 |
住址 |
id_no |
string |
362233196007150036 |
公民身份号码 |
name |
string |
潘建辉 |
姓名 |
sex |
string |
男 |
性别 |
minzu |
string |
汉 |
民族 |
birthday |
string |
1960-07-15 |
出生日期 |
身份证国徽面
名称 |
类型 |
示例值 |
描述 |
class_name |
string |
idcard_guohui |
类别-身份证国徽面 |
issue_organization |
string |
桃江县公安局 |
签发机关 |
available_start_date |
string |
2013-03-05 |
有效期限开始日期 |
available_end_date |
string |
2023-03-05 |
有效期限结束日期 |
2.返回示例
身份证信息面
{
"code": 0,
"message": "success",
"data": {
"class_name":"idcard_info",
"address": "江西省新余市渝水区长青中路6号5栋3单元2楼19号",
"birthday": "1960-07-15",
"id_no": "362233196007150036",
"minzu": "汉",
"name": "潘建辉",
"sex": "男"
},
"requestId": "98a39e53-84d4-448e-9081-29f64a6cd984"
}
身份证国徽面
{
"code": 0,
"message": "success",
"data": {
"class_name":"idcard_guohui",
"available_end_date": "2023-03-05",
"available_start_date": "2013-03-05",
"issue_organization": "桃江县公安局"
},
"requestId": "98a39e53-84d4-448e-9081-29f64a6cd984"
}
四、错误码信息
1.系统级错误码
详见返回码
2.业务错误码
错误号(code) |
错误信息(message) |
描述 |
0 |
success |
成功 |
1000 |
param error |
参数错误 |
1001 |
sign error |
签名错误 |
1002 |
file error |
文件错误 |
1003 |
upload media error |
内部文件上传错误 |
1004 |
ai request error |
ai请求错误 |
1005 |
no authorization |
无权限认证 |
1006 |
form error |
表单错误 |
1007 |
no content |
没有识别出内容 |
1100 |
system error |
系统内部错误 |