/ocr/driving_license

1.接口描述

该 API 用于识别驾驶证图像上的文字信息。

  • 图片要求
    1. 格式为 JPG（JPEG），PNG
    2. 宽和高大于 128px，小于等于6000px
    3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.deepfinch.com/ocr/driving_license

调试工具

Debugging Tool

2.请求参数

2.1 请求头域

字段 类型 必需 描述
X-DF-API-ID string 是 API调用凭证信息，详细信息请参考API调用
X-DF-API-SECRET string 是 API调用凭证信息，详细信息请参考API调用

2.2 请求体

字段 类型 必需 描述
file file 见下方注释 需上传的图片文件，上传本地图片进行检测时选取此参数
url string 见下方注释 图片网络地址，采用抓取网络图片方式时需选取此参数

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

3.返回参数

字段 类型 说明
request_id string 本次请求的id
status string 返回状态，正常为 OK，其他值表示失败，详见错误码
result object 驾驶证文字信息，详见result 字段结构

result 字段结构：

字段 类型 说明
license_number string 证件号
name string 姓名
gender string 性别
nationality string 国籍
address string 住址
birthday string 出生日期
issue_date string 初始领证日期
class string 准驾车型
valid_from string 有效起始日期
valid_for string 有效期限
side string 正反面
version int 驾驶证版本, 1: 2008或更早版本, 2: 2013版本
valid_date string 有效期时间段（ 若version: 2 则有此字段 ）

结果示例

version: 1
{
    "request_id": "TID4120b0ef91cd4e059b1a0c9854e8a47d",
    "status": "OK",
    "result": {
        "license_number": "******************",
        "name": "某**",
        "gender": "男",
        "nationality": "中国",
        "address": "**省**市***路****号",
        "birthday": "1965-06-06",
        "issue_date": "1995-01-05",
        "class": "A2E",
        "valid_from": "2012-01-05",
        "valid_for": "10年",
        "side": "front",
        "version": 1
    }
}
version: 2
{
    "request_id": "TID6c9b736b357443daa33ada59c8921a0d",
    "status": "OK",
    "result": {
        "license_number": "******************",
        "name": "某**",
        "gender": "男",
        "nationality": "中国",
        "address": "**省**市***路****号",
        "birthday": "1991-05-02",
        "issue_date": "2014-02-19",
        "class": "C1",
        "valid_from": "2014-02-19",
        "valid_for": "2020-02-19",
        "side": "front",
        "version": 2,
        "valid_date": "2014-02-19 至 2020-02-19"   
    }
}

4.错误码

状态码 status 字段 说明
400 INVALID_ARGUMENT 请求参数错误
400 DETECTION_FAILED 图片检测失败
400 DOWNLOAD_ERROR 网络地址图片获取失败
401 UNAUTHORIZED 未授权或授权失败
401 KEY_EXPIRED 账号过期
403 NO_PERMISSION 无调用权限
403 OUT_OF_QUOTA 调用次数超出限额
403 RATE_LIMIT_EXCEEDED 调用频率超出限额
404 NOT_FOUND 请求路径错误
500 INTERNAL_ERROR 服务器内部错误

备注: 以上40X系列错误描述请参考reason字段

输出样例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'file' or 'url' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

results matching ""

    No results matching ""