接口描述
对上传的身份证信息面及国徽面图片进行OCR，返回身份证上的信息
接口
/v2/identity/auth/api/ocr/idcard
请求方式
POST
请求头
提供两种安全接入方式，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 项目ID |
Content-Type | string | 是 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 |
Accept | string | 是 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
infoImg | string | 否 | body | 身份证信息面图片BASE64字符串。 注意不要带图片BASE64前缀“data:image/jpeg;base64,” 图片类型支持：jpg，jpeg，png，bmp 图片建议分辨率为1024*768，图片大小控制在3M以内 infoImg与emblemImg至少传一个值 |
emblemImg | string | 否 | body | 身份证国徽面图片BASE64字符串 注意不要带图片BASE64前缀“data:image/jpeg;base64,” 图片类型支持：jpg，jpeg，png，bmp 图片建议分辨率为1024*768，图片大小控制在3M以内 infoImg与emblemImg至少传一个值 |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |
code | int | 是 | 接口响应结果码 | |
message | string | 否 | 接口响应结果描述 | |
data | object | 否 | 接口响应结果数据 | |
verifyId | string | 否 | 业务Id | |
name | string | 否 | 姓名 | |
idNo | string | 否 | 身份证号 | |
gender | string | 否 | 性别 | |
birthDay | string | 否 | 出生日期 | |
nation | string | 否 | 民族 | |
address | string | 否 | 住址 | |
validityPeriod | string | 否 | 有效期限，YYYY.MM.DD-YYYY.MM.DD 或 YYYY.MM.DD-长期 | |
issuedBy | string | 否 | 发证机关 | |
请求示例
{
"infoImg": "/9j/4AAQSkZJRgABAQEAS......",
"emblemImg": "/9j/4AAQSkZJRgABAQEAY......"
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"verifyId": "8521cf86-cf6f-****-****-d272f7c3b213",
"name": "陈三",
"idNo": "331*******4388",
"gender": "女",
"birthDay": "1993/08/08",
"nation": "汉",
"address": "浙江省*******84号",
"validityPeriod": "2014.01.14-2024.01.14",
"issuedBy": "****市公安局"
}
}错误码
错误码 | 错误描述 | 解决方案 |
30503129 | 身份证人像面识别失败 | 身份身份证OCR人像页图片不正确，或者模糊有问题。需换成正确、清晰的人像页图片。 |
30503131 | 身份证国徽面识别失败 | 身份证OCR国徽页图片不正确，或者模糊有问题。需换成正确、清晰的国徽页图片。 |
我要纠错