# 版本

5.0.0

# 描述

检测和识别中华人民共和国机动车驾驶证（以下称“驾照”）图像为结构化的文字信息。支持驾照主页正面，副页正面。

● 驾照图像须为正拍（垂直角度拍摄），但是允许有一定程度的旋转角度；
● 图像长宽不得超过4096像素，否则会抛出错误。
● 仅支持图像里有一个驾照的主页正面或一个驾照的副页正面。

# 调用URL

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

# 调用方法

POST

参数

必选/可选	参数名	类型	参数说明
必选	sign	String	调用此API客户的签名，具体的签名产生方式请查阅鉴权
	sign_version	String	签名算法版本号，请传递：hmac_sha1
	image	String	一个图片，二进制文件，需要用Post Multipart/Form-Data的方式上传 注：图像存储尺寸不能超过2MB，像素尺寸的长或宽都不能超过4096像素
可选	side	String	main：驾驶证主页（默认值） second：驾驶证副页

# 返回值

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

字段	类型	说明
request_id	String	用于区分每一次请求的唯一的字符串。除非发生404（API_NOT_FOUND )或 403 （AUTHORIZATION_ERROR）错误，此字段必定返回。
content_main	Object	驾驶证主页识别结构体，若side=main，则返回此字段；注意：此字段可能返回 null，表示取不到有效值。
content_second	Object	驾驶证副页识别结构体，若side=second，则返回此字段；注意：此字段可能返回 null，表示取不到有效值。
time_used	Int	整个请求所花费的时间，单位为毫秒。除非发生404（API_NOT_FOUND )或 403 （AUTHORIZATION_ERROR）错误，此字段必定返回。
error	String	错误信息。当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节。否则此字段不存在。

注：不能确定字段内容时，结果会是null。

content字段结构：

主页/副页	字段	类型	说明
content_main	address	String	住址
	birthday	Object	生日，一个Object对象，包含day（日）, month（月）, year （年）三个字段，都是Int类型值
	gender	String	性别（男/女）
	license_number	String	驾驶证号
	name	String	姓名
	class	String	准驾车型
	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字段。
	type	Int	驾驶证版本。 返回 1，表示是2013版本驾驶证。 返回 0，表示是2008或更早版本驾驶证。
	head_rect	Object	驾驶证中人脸框的位置，分别包含左上（lt）、右上（rt）、右下（rb）、左下（lb）四个角点。每个点包括x,y两个参数，代表横纵坐标在原始图片的位置比例，参数为Float类型，小数点后5位有效数字。值可能会超过图本身。
content_second	name	String	姓名
	license_number	String	驾驶证号
	file_number	String	档案编号

# 返回值示例

正确请求返回示例-主页

{
	"request_id": "1705474466,cbacf1e9-9906-45de-929d-ac53a442b7c0",
	"time_used": 736,
	"content_main": {
		"address": "广东省潮州市湘桥区六亩村XXXX",
		"birthday": {
			"year": 1989,
			"month": 5,
			"day": 13
		},
		"nationality": "中国",
		"class": "C1",
		"issue_date": {
			"year": 2011,
			"month": 5,
			"day": 19
		},
		"name": "赖XX",
		"license_number": "445102198905XXXXXXX",
		"issued_by": "广东省广州市公安局交通警察支队",
		"gender": "男",
		"type": 0,
		"head_rect": {
			"lt": {
				"x": 0.72833,
				"y": 0.5675
			},
			"rt": {
				"x": 0.91833,
				"y": 0.5675
			},
			"rb": {
				"x": 0.91833,
				"y": 0.8525
			},
			"lb": {
				"x": 0.72833,
				"y": 0.8525
			}
		},
		"valid_from": {
			"year": 2011,
			"month": 5,
			"day": 19
		},
		"valid_for": "6年"
	},
	"content_second": null
}

正确请求返回示例-副页

{
	"request_id": "1705474508,44c17aa9-1128-4f55-8eb8-16436c0b3b9f",
	"time_used": 381,
	"content_main": null,
	"content_second": {
		"name": "张xx",
		"license_number": "3625311982030XXXXXX",
		"file_number": "31739189XXXX"
	}
}

请求失败返回示例

{

   "error" : "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	客户发送的请求大小超过了5MB限制。该错误的返回格式为纯文本，不是json格式。
500	INTERNAL_ERROR	服务器内部错误，当此类错误发生时请再次请求，如果一直出现此类错误，请及时联系客服。

# 调用示例

curl "https://api.megvii.com/faceid/v5/ocr_driver_license"

-F sign=@sign -F sign_version="hmac_sha1"

-F side="second"

-F image=@image_driver_license.jpg

# 历史版本文档

驾驶证V2.0.0版本，仅支持驾驶证主页正面识别，如有需要V2.0.0版本的文档，请从这里下载：ocr_driver_license V2.0.0（旧版本）文档。