接入文档
证件OCR识别
驾驶证识别接入
API接入
API接入

# 版本

2.0.0

# 描述

检测和识别中华人民共和国机动车驾驶证(以下称“驾照”)图像为结构化的文字信息。目前只支持驾照主页正面,不支持副页正面反面。

● 驾照图像须为正拍(垂直角度拍摄),但是允许有一定程度的旋转角度;
● 图像长宽不得超过4096像素,否则会抛出错误。
● 仅支持图像里有一个驾照的主页正面,如果同时出现多页、或正副页同时出现,可能会返回空结果。

# 调用URL

https://api.megvii.com/faceid/v2/ocr_driver_license

# 调用方法

POST

参数

必选/可选 参数名 类型 参数说明
必选 api_key String 用于验证客户身份的API Key;
对于每一个客户此字段不会变更,相当于用户名。
api_secret String 用于验证客户身份的API Secret,
对于每一个客户可以申请变更此字段,相当于密码
image File 一个图片,二进制文件,需要用Post Multipart/Form-Data的方式上传
:图像存储尺寸不能超过2MB,像素尺寸的长或宽都不能超过4096像素。

# 返回值

如果没有检测出行驶证,不返回任何字段

字段 类型 说明
request_id String 用于区分每一次请求的唯一的字符串。除非发生404(API_NOT_FOUND )或 403 (AUTHORIZATION_ERROR)错误,此字段必定返回。
type Int 驾驶证版本。
返回 1,表示是2013版本驾驶证。
返回 0,表示是2008或更早版本驾驶证。
address String 住址
birthday Object 生日,一个Object对象,包含day(日), month(月), year (年)三个字段,都是Int类型值
gender String 性别(男/女)
license_number String 驾驶证号
name String 姓名
class String 准驾车型
side String 表示驾驶证的正面或者反面。该字段目前只会返回“front”,表示是正面
nationality String 国籍
issued_by String 签发机关
issue_date Object 初次领证日期,一个Object对象,包含day(日), month(月), year (年)三个字段,都是Int类型值
valid_from Object 有效日期,一个Object对象,包含day(日), month(月), year (年)三个字段,都是Int类型值
valid_for String 有效年限,例如 6年
valid_date String 有效期限格式为:yyyy.mm.dd-yyyy.mm.dd
根据驾驶证版本不同,一种情况会返回valid_from和valid_for两个字段,另一种情况只返回valid_date字段。
head_rect Object 身份证中人脸框的位置,分别包含左上(lt)、右上(rt)、右下(rb)、左下(lb)四个角点。每个点包括x,y两个参数,代表横纵坐标在原始图片的位置比例,参数为Float类型,小数点后5位有效数字。值可能会超过图本身。
time_used Int 整个请求所花费的时间,单位为毫秒。除非发生404(API_NOT_FOUND )或 403 (AUTHORIZATION_ERROR)错误,此字段必定返回。

注:不能确定字段内容时,结果会是null;身份证并没有做逻辑校验(如:2月30日,身份证长度为15位等)。

# 返回值示例

正确请求返回示例

{

  "request_id" : "1461740007,71eeb124-08f0-47b3-8fc8-ac048cfa1372",

"type":1, 

 "address": "北京市海淀区XXXX",

 "birthday": {

  "day": 2,

  "month": 6,

  "year": 1991

 },

 "head_rect": {

       "lt": {

           "x": 0.61991,

           "y": 0.19362

       },

       "rt": {

           "x": 0.92181,

           "y": 0.19843

       },

       "rb": {

           "x": 0.92718,

           "y": 0.73771

       },

       "lb": {

           "x": 0.62164,

           "y": 0.73526

       }

  },

 "gender": "男",

 "license_number": "xxxxxx19910602xxxx",

 "name": "陈XX",

 "class": "C2",

 "side":"front",

 "nationality": "中国",

 "issued_by": "广州省深圳市公安局交通警察支队",

 "issue_date": {

  "day": 2,

  "month": 6, 

  "year": 2011

 },

"valid_date":"2010.11.13-2020.11.13", 

 "time_used" : 1020

}

请求失败返回示例

{

   "error_message" : "INVALID_IMAGE_SIZE: image",

   "request_id" : "1461740007,71eeb124-08f0-47b3-8fc8-ac048cfa134d",

   "time_used" : 4

}

# 错误信息

HTTP 状态代码
错误信息 说明
400 IMAGE_ERROR_UNSUPPORTED_FORMAT 图像无法正确解析,有可能不是一个图像文件、或有数据破损。
400 INVALID_IMAGE_SIZE:<param> 客户上传的图像像素尺寸的长或宽超过4096像素。<param>对应图像太大的那个参数的名称
请注意:如果图片存储尺寸大于2MB,会触发错误413(Request Entity Too Large)。
400 MISSING_ARGUMENTS: <key> 缺少某个必要参数。
403 AUTHORIZATION_ERROR AppSecret和Appkey不匹配,或者该Appkey无权调用此API
403 CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
404 API_NOT_FOUND 所调用的API不存在
413 Request Entity Too Large 客户发送的请求大小超过了2MB限制。该错误的返回格式为纯文本,不是json格式。
500 INTERNAL_ERROR 服务器内部错误,当此类错误发生时请再次请求,如果一直出现此类错误,请及时联系客服。

# 调用示例

curl "https://api.megvii.com/faceid/v2/ocr_driver_license" -F api_key=<api_key>

-F api_secret=<api_secret>

-F image=@image_driver_license.jpg

该文档未解决您的疑问?查看常见问题