身份证OCR
接口描述
- 对上传的身份证信息面及国徽面图片进行OCR，返回身份证上的信息
接口地址
/v2/identity/auth/api/ocr/idcard
请求方式
- POST
- 请求报文体采用Json数据格式，编码方式采用UTF-8编码
请求参数
| 参数名 | 说明 | 参数类型 | 是否必填 | 类型 |
|---|---|---|---|---|
| infoImg | 身份证信息面图片BASE64字符串，注意不要带图片BASE64前缀“data:image/jpeg;base64,”，最大7MB | body | 是 | string |
| emblemImg | 身份证国徽面图片BASE64字符串，注意不要带图片BASE64前缀“data:image/jpeg;base64,”，最大7MB | body | 否 | string |
请求示例
POST /v2/identity/auth/api/ocr/idcard HTTP/1.1
{
"infoImg": "/9j/4AAQSkZJRgABAQEAS......",
"emblemImg": "/9j/4AAQSkZJRgABAQEAY......"
}
响应参数
| 参数名 | 说明 | 类型 |
|---|---|---|
| code | int | 接口响应结果码 |
| message | string | 接口响应结果描述 |
| data | object | 接口响应结果数据 |
| verifyId | string | 业务Id |
| name | string | 姓名 |
| idNo | string | 身份证号 |
| gender | string | 性别 |
| birthDay | string | 出身日期，YYYY/MM/DD |
| nation | string | 民族 |
| address | string | 住址 |
| validityPeriod | string | 有效期限，YYYY.MM.DD-YYYY.MM.DD 或 YYYY.MM.DD-长期 |
| issuedBy | string | 发证机关 |
响应示例
{
"code": 0,
"message": "成功",
"data": {
"verifyId": "79be36a7-96ba-4989-9b79-ecc11df90c5c",
"name": "张三",
"idNo": "330100199001015011",
"gender": "男",
"birthDay": "1990/01/01",
"nation": "汉",
"address": "浙江省杭州市......",
"validityPeriod": "2019.01.01-2039.01.01",
"issuedBy": "XXX公安局"
}
}
错误码
| 错误码 | 错误信息 | 错误原因 |
|---|---|---|
| 30500101 | 参数错误：infoImg不能为空 | 身份证信息面图片BASE64字符串为空 |
| 30500101 | 参数错误：文件大小超出限制，最大7MB | 图片大小超过限制 |
| 30503127 | OCR识别失败 | OCR识别失败 |