/ocr/license_detail_detect

1.接口描述

该 API 用于识别图像上的证件(包含行驶证,驾驶证,身份证和银行卡),返回证件的类型、位置信息及证件详情。

  • 图片要求:
    1. 格式为 JPG(JPEG),BMP,PNG,GIF,TIFF
    2. 宽和高大于 8px,小于等于 4000px
    3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.linkface.cn/ocr/license_detail_detect

2.请求参数

字段 类型 必需 描述
api_id string API 账户
api_secret string API 密钥
file file 见下方注释 需上传的图片文件,上传本地图片进行检测时选取此参数
url string 见下方注释 图片网络地址,采用抓取网络图片方式时需选取此参数
image_id string 见下方注释 图片的id,在云端上传过图片可采用此参数

请求参数 file,urlimage_id 必须选择其中的一个。

url 中含有不少特殊字符,若将 URL 放入 Query String 中则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。 目前支持 http/https 等协议的网络地址。下载限时 5s,超时后仍未下载完成则属于失败。 参数 file 需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。

3.返回参数

字段 类型 说明
request_id string 本次请求的id
status string 状态,正常为 OK,其他值表示失败,详见错误码
image_id string 使用file、url方式上传图片返回的图片的云端id
result array of object 证件类型信息, ocr_statusOK时才返回

result 数组中字段的结构为:

字段 类型 说明
type string 证件类型,vehicle:行驶证 ,driver:驾驶证,id:身份证,bankcard:银行卡
score string 置信度
rect object 证件矩形框,top、bottom 分别表示证件框上、下边框的纵坐标,left、right 分别表示证件框左、右边框的横坐标
ocr_status string 证件详细信息识别状态,正常为 OK
info object 证件详情,相关字段参见/ocr/idcard/ocr/bankcard/ocr/driving_license/ocr/vehicle_license
validity object 各项信息有效性,仅在idcard识别中出现。
side string 身份证方向信息。front 代表身份证正面,back 代表身份证反面,仅在idcard识别中出现。
rotate string 旋转角度。开启自动旋转功,返回旋转的角度值,可能的值为 cw90,cw180,cw270,表明顺时针旋转的角度。如果没有发生旋转,则不返回此字段,仅在idcard识别中出现。
证件识别结果示例
{
    "request_id": "TIDd9b34b2a2cd24dcbacea7c7f05c90537",
    "status": "OK",
    "image_id": "8520544babd14bc981bcb7122eed40b8",
    "result": [
        {
            "rect": {
                "bottom": "273",
                "left": "230",
                "right": "457",
                "top": "122"
            },
            "score": "0.999723",
            "type": "bankcard",
            "ocr_status": "OK",
            "info": {
                "card_number": "621***********7721",
                "bank_name": "中国工商银行",
                "bank_identification_number": "1020000",
                "card_name": "牡丹卡普卡",
                "card_type": "借记卡"
            }
        },
        {
            "rect": {
                "bottom": "280",
                "left": "5",
                "right": "400",
                "top": "28"
            },
            "score": "0.998241",
            "type": "id",
            "ocr_status": "OK",
            "side": "front",
            "info": {
                "name": "XXX",
                "sex": "男",
                "nation": "汉",
                "year": "1990",
                "month": "2",
                "day": "10",
                "address": "广东省揭阳市榕城区东升新河村新安围12巷621号",
                "number": "XXXXXXXXXXXXXXXX"
            },
            "validity": {
                "name": true,
                "sex": true,
                "birthday": true,
                "address": true,
                "number": true
            }
        },
        {
            "rect": {
                "bottom": "209",
                "left": "34",
                "right": "303",
                "top": "22"
            },
            "score": "0.999787",
            "type": "driver",
            "ocr_status": "OK",
            "info": {
                "address": "河南省昆州市仁县上云桥镇云三段村杨子组子园002号",
                "birthday": "1981-01-14",
                "class": "A2",
                "nationality": "中国",
                "license_number": "XXXXXXXXXXXXXXXX",
                "issue_date": "1999-11-25",
                "name": "XXX",
                "gender": "男",
                "valid_for": "10年",
                "valid_from": "2011-11-25",
                "side": "front",
                "version": 1
            }
        },
        {
            "rect": {
                "bottom": "437",
                "left": "31",
                "right": "298",
                "top": "252"
            },
            "score": "0.999965",
            "type": "vehicle",
            "ocr_status": "OK",
            "info": {
                "plate_no": "粤XXXXXX",
                "vehicle_type": "小型轿车",
                "owner": "广州市强龙出相汽车有限公司",
                "address": "广东省广州市天河区沙和路105号516房",
                "model": "桑塔纳牌SVW7182QQD1",
                "vin": "XXXXXXXXXXXXXXXXXX",
                "engine_no": "208358",
                "register_date": "2012-03-26",
                "issue_date": "2012-03-26",
                "use_character": "出租客运"
            }
        }
    ]
}

4.错误码

状态码 status 字段 说明
400 ENCODING_ERROR 参数非UTF-8编码
400 DOWNLOAD_TIMEOUT 网络地址图片获取超时
400 IMAGE_ID_NOT_EXIST 图片不存在
400 CORRUPT_IMAGE 文件不是图片文件或已经损坏
400 DOWNLOAD_ERROR 网络地址图片获取失败
400 IMAGE_FILE_SIZE_TOO_BIG 图片体积过大
400 INVALID_IMAGE_FORMAT_OR_SIZE 图片大小或格式不符合要求
400 INVALID_ARGUMENT 请求参数错误,具体原因见 reason 字段内容
400 INVALID_LICENSE_OR_CARD 图片未识别
401 UNAUTHORIZED 账号或密钥错误
401 KEY_EXPIRED 账号过期,具体情况见 reason 字段内容
403 RATE_LIMIT_EXCEEDED 调用频率超出限额
403 NO_PERMISSION 无调用权限
403 OUT_OF_QUOTA 调用次数超出限额
404 NOT_FOUND 请求路径错误
500 OCR_SERVER_ERROR 识别服务器异常
500 INTERNAL_ERROR 服务器内部错误
输出样例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'image_id', 'file' or 'url' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

  • cURL 样例
curl -X POST "https://cloudapi.linkface.cn/ocr/license_detail_detect?api_id=ID&api_secret=SECRET" \
  -F file=@/PATH/TO/IMAGE
  • HTTPie 样例
http -f POST "https://cloudapi.linkface.cn/ocr/license_detail_detect?api_id=ID&api_secret=SECRET" \
  file@/PATH/TO/IMAGE

results matching ""

    No results matching ""