主题
护照 OCR
接口描述
通过光学字符识别技术,识别护照姓名、身份证号码、国家码、出生日期、出生地点、签发日期等结构化数据.
请求说明
HTTP 方法:
POST请求 URL:
/ai-cloud-face/api/v1/ocrengineHeader如下:
| 参数名称 | 值 |
|---|---|
| Content-Type | application/json;charset=UTF-8 |
Body中放置请求参数,参数详情如下:
请求参数:
| 参数名称 | 必填 | 数据类型 | 长度 | 参数描述 |
|---|---|---|---|---|
| img | 是 | String | 1-3000k | 待处理图片(base64 编码),原始图片大小需要小于 3M; |
| busFlowId | 否 | String | 0-64 | 业务流水号,业务系统唯一序列号(对账用,建议传入) |
请求示例:
{
"img":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQ......"
}返回说明
返回参数:
| 返回值名称 | 数据类型 | 长度 | 描述 |
|---|---|---|---|
| code | int | 1-8 | 返回结果,0表示成功 |
| message | String | 1-255 | 返回码描述 |
| data | Object | - | 返回的数据 |
| -busFlowId | String | 1-64 | 业务流水号,业务系统唯一序列号 |
| -flowId | String | 1-64 | 交易流水ID(建议保存) |
| -ocrEngineRet | Object | - | 护照OCR识别结果 |
| --Type | OcrRet | - | 护照类型 |
| --CountryCode | OcrRet | - | 国家码 |
| --Surname | OcrRet | - | 姓 |
| --Givennames | OcrRet | - | 名 |
| --Name | OcrRet | - | 姓名 |
| --NamePinyin | OcrRet | - | 姓名拼音 |
| --Sex | OcrRet | - | 性别 |
| --Nationality | OcrRet | - | 国籍 |
| --IdNumber | OcrRet | - | 身份证号 |
| --Dateofbirth | OcrRet | - | 出生日期 |
| --Placeofbirth | OcrRet | - | 出生地点 |
| --Dateofissue | OcrRet | - | 签发日期 |
| --Dateofexpiry | OcrRet | - | 有效期至 |
| --Placeofissue | OcrRet | - | 签发地点 |
| --Officeofissue | OcrRet | - | 签发机关 |
| --PassportNo | OcrRet | - | 护照号码 |
OcrRet对象:
| 返回值名称 | 数据类型 | 长度 | 描述 |
|---|---|---|---|
| key | String | 1-64 | 属性key |
| data | String | 1-511 | 属性值 |
| pos | OcrPos | - | 识别坐标 |
OcrPos对象:
| 返回值名称 | 数据类型 | 长度 | 描述 |
|---|---|---|---|
| p1 | Point | - | 坐标1 |
| p2 | Point | - | 坐标2 |
| p3 | Point | - | 坐标3 |
| p4 | Point | - | 坐标4 |
Point对象:
| 返回值名称 | 数据类型 | 长度 | 描述 |
|---|---|---|---|
| x | int | 1-4 | x坐标 |
| y | int | 1-4 | y坐标 |
返回示例:
{
"code": 0,
"data": {
"ocrEngineRet": {
"Authority": {
"data": "公安部出入境管理局",
"pos": {
"p1": {
"x": 429,
"y": 681
},
"p2": {
"x": 723,
"y": 681
},
"p3": {
"x": 723,
"y": 717
},
"p4": {
"x": 429,
"y": 717
}
}
},
..........
"Type": {
"data": "P",
"pos": {
"p1": {
"x": 401,
"y": 174
},
"p2": {
"x": 429,
"y": 174
},
"p3": {
"x": 429,
"y": 211
},
"p4": {
"x": 401,
"y": 211
}
}
}
}
},
"success": true,
"message": "success"
}错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共CODE码表
| 码值 | 是否成功 | 是否计费 | 描述 |
|---|---|---|---|
| 00000000 | 是 | 是 | 成功 |
| 50028100 | 否 | 否 | 图片不能为空 |
| 50028103 | 否 | 否 | 图片大小不能超过3M |
| 50028280 | 否 | 否 | 护照识别异常 |
| 50028226 | 否 | 否 | 引擎检测异常 |
| 50028227 | 否 | 否 | 引擎检测异常 |
| 50028228 | 否 | 否 | 引擎检测异常 |