OCR识别类服务
4.3.1. OCR身份证识别服务
4.3.1.1. 服务使用场景
4.3.1.2. 产品功能说明
4.3.1.3. 业务规则
4.3.1.4. API对接说明
/api/jjzy/ocr/ocrIdCard输入参数列表
| 请求参数 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| image | 和url二选一 | String | data:image/png; base64,iVBORw0KGgo... | 图像数据，base64编码后进行urlencode，要求base64编码和urlencode后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/jpeg/png/bmp格式 |
| url | 和image二选一 | String | http://zy.zjcvmc.cn/static/ img/bg_login.8539120.png | 图片完整URL，URL长度不超过1024字节，URL对应的图片base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/jpeg/png/bmp格式，当image字段存在时url字段失效，请注意关闭URL防盗链 |
| id_card_side | 是 | String | front | -front：身份证含照片的一面 -back：身份证带国徽的一面 自动检测身份证正反面，如果传参指定方向与图片相反，支持正常识别，返回参数image_status字段为"reversed_side" |
| detect_ps | 否 | String | true | 是否检测上传的身份证被PS，默认不检测。可选值： -true：检测 -false：不检测 |
| detect_risk | 否 | String | true | 是否开启身份证风险类型（身份证复印件、临时身份证、身份证翻拍、修改过的身份证）检测功能，默认不开启，即：false。 -true：开启，请查看返回参数risk_type； -false：不开启 |
| detect_quality | 否 | String | true | 是否开启身份证质量类型（清晰模糊、边框/四角不完 整、头像或关键字段被遮挡/马赛克）检测功能，默认不开启，即：false。 -true：开启，请查看返回参数card_quality； -false：不开启 |
| detect_photo | 否 | String | true | 是否检测头像内容，默认不检测。可选值： true-检测头像并返回头像的base64编码及位置信息 |
| detect_card | 否 | String | true | 是否检测身份证进行裁剪，默认不检测。可选值： true-检测身份证并返回证照的base64编码及位置信息 |
| detect_direction | 否 | String | true | 是否检测上传的身份证图片方向，默认不检测。可选值： -true：检测 -false：不检测 |
输出参数列表
| 响应参数 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| code | 是 | Int | 200 | 状态码 |
| message | 是 | String | 请求成功 | 返回提示消息 |
| data | 否 | Object | - | 获取成功不为空 |
data字段包含
| 参数 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| words_result_num | 是 | Uint32 | 5 | 识别结果数，表示words_result的元素个数 |
| direction | 否 | Int32 | 2 | 图像方向，输入参数detect_direction=true时返回。 - -1：未定义， - 0：正向， - 1：逆时针90度， - 2：逆时针180度， - 3：逆时针270度 |
| image_status | 是 | String | normal | normal-识别正常 reversed_side-身份证正反面颠倒 non_idcard-上传的图片中不包含身份证 blurred-身份证模糊 other_type_card-其他类型证照 over_exposure-身份证关键字段反光或过曝 over_dark-身份证欠曝（亮度过低） unknown-未知状态 |
| card_ps | 否 | String | 0 | 输入参数detect_ps=true时，则返回该字段，判断身份证是否被PS，返回值： - 0：正常， - 1：PS， - -1：无效 |
| risk_type | 否 | String | normal | 输入参数detect_risk=true时，则返回该字段识别身份证风险类型: normal-正常身份证； copy-复印件； temporary-临时身份证； screen-翻拍； unknown-其他未知情况 |
| edit_tool | 否 | String | Adobe Photoshop CC 2014 (Macintosh) | 如果参数detect_risk=true时，则返回此字段。如果检测身份证被编辑过，该字段指定编辑软件名称，如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值无此参数 |
| card_quality | 否 | Object | - | 输入参数detect_quality=true时，则返回该字段识别身份证质量类型 |
| photo | 否 | String | iVBORw0KGgoAAAAN SUhEUgAAAGQAA5... | 当请求参数detect_photo=true时返回，头像切图的base64编码（无编码头，需自行处理） |
| photo_location | 否 | Object | - | 当请求参数detect_photo=true时返回，头像的位置信息（坐标0点为左上角） |
| card_image | 否 | String | iVBORw0KGgoAAA ANSUhADsF9h90t5... | 当请求参数detect_card=true时返回，身份证裁剪切图的base64编码（无编码头，需自行处理） |
| card_location | 否 | Object | - | 当请求参数detect_card=true时返回，身份证裁剪切图的位置信息（坐标0点为左上角） |
| idcard_number_type | 是 | Int | 1 | 用于校验身份证号码、性别、出生是否一致，输出结果及其对应关系如下： - -1：身份证正面所有字段全为空 - 0：身份证证号不合法，此情况下不返回身份证证号 - 1：身份证证号和性别、出生信息一致 - 2：身份证证号和性别、出生信息都不一致 - 3：身份证证号和出生信息不一致 - 4：身份证证号和性别信息不一致 |
| words_result | 是 | Array[] | - | 定位和识别结果数组 |
card_quality字段包含
| 参数 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| IsClear | 是 | String | 1 | 质量类型，是否清晰 |
| IsClear_propobility | 是 | String | 0.5 | "是否清晰"质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当IsClear_propobility超过0.5时，对应IsClear返回1，低于0.5，则返回0 |
| IsComplete | 是 | String | 1 | 质量类型，是 否边框/四角完整 |
| IsComplete_propobility | 是 | String | 0.6 | "是否边框/四角完整"质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当IsClear_propobility超过0.5时，对应IsComplete返回1，低于0.5，则返回0 |
| IsNoCover | 是 | String | 1 | 质量类型，是否头像、关键字段无遮挡/马赛克 |
| IsNoCover_propobility | 是 | String | 0.4 | "是否头像、关键字段无遮挡/马赛克"质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当IsNoCover_propobility超过0.3时，对应IsNoCover返回1，低于0.3，则返回0 |
words_result字段包含
| 字段名 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| 住址 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 南京市江宁区弘景大道3889号 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角）；参数key有：left（左）、top（上）、width（宽）、height（高） |
| 公民身份号码 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 3308811999041XXXXX | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 出生 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 19990417 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 姓名 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 李云龙 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 民族 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 汉 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 性别 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 男 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（ 坐标0点为左上角） |
| 失效日期 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 20390711 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 签发机关 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 陆丰市公安局 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
| 签发日期 | - | Object | - | 包含words和location字段 |
| words | 否 | String | 20190606 | 识别结果字符串 |
| location | 是 | Array[] | {"left": 270, "top": 357, "width": 355, "height": 45} | 位置数组（坐标0点为左上角） |
location字段包含
| 参数 | 必须参数 | 参数类型 | 示例数据 | 说明 |
|---|---|---|---|---|
| left | 是 | Uint32 | 267 | 表示定位位置的长方形左上顶点的水平坐标 |
| top | 是 | Uint32 | 453 | 表示定位位置的长方形左上顶点的垂直坐标 |
| width | 是 | Uint32 | 459 | 表示定位位置的长方形的宽度 |
| height | 是 | Uint32 | 99 | 表示定位位置的长方形的高度 |
数据体返回实例
{
"log_id": "1559208562721579319",
"direction": 0,
"image_status": "normal",
"photo": "/9j/4AAQSkZJRgABA......",
"photo_location": {
"width": 1189,
"top": 638,
"left": 2248,
"height": 1483
},
"card_image": "/9j/4AAQSkZJRgABA...",
"card_location": {
"top": 328,
"left": 275,
"width": 1329,
"height": 571
},
"words_result": {
"住址": {
"location": {
"left": 267,
"top": 453,
"width": 459,
"height": 99
},
"words": "南京市江宁区弘景大道3889号"
},
"公民身份号码": {
"location": {
"left": 443,
"top": 681,
"width": 589,
"height": 45
},
"words": "330881XXXXXXXXXXXX"
},
"出生": {
"location": {
"left": 270,
"top": 355,
"width": 357,
"height": 45
},
"words": "19990417"
},
"姓名": {
"location": {
"left": 267,
"top": 176,
"width": 152,
"height": 50
},
"words": "伍某"
},
"性别": {
"location": {
"left": 269,
"top": 262,
"width": 33,
"height": 52
},
"words": "男"
},
"民族": {
"location": {
"left": 492,
"top": 279,
"width": 30,
"height": 37
},
"words": "汉"
}
},
"words_result_num": 6
}