You need to enable JavaScript to run this app.
导航

接口文档

最近更新时间2021.12.16 13:59:15

首次发布时间2021.12.16 13:59:15

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权
图片要求1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片像素尺寸:为了保证文字识别效果,推荐图片中驾驶证最短边长不低于256像素。
3. 图片文件大小:最大 4 MB。驾驶证主体尽量占据图片主要区域。
4. 注意图片质量:保证驾驶证图片足够清晰,不应该有因为压缩导致的噪声,避免对驾驶证正反面的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。
5. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。
6. 驾驶证图片不可以是复印件、翻拍件、PS件等。

输入参数

Query参数:

参数可选/必选类型说明
Action必选String接口名,取值:DrivingLicense
Version必选String版本号,取值:2020-08-26

Body参数:

参数可选/必选类型说明
image_base64必选String驾驶证图片文件,base64编码

API返回 (通用返回字段见通用返回字段及错误码

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息字段说明见下方

main_info 字段说明

字段类型说明备注
id_numberString证号主页信息
nameString姓名主页信息
sexString性别主页信息
nationalityString国籍主页信息
addressString住址主页信息
date_of_birthString出生日期主页信息
date_of_first_issueString初次领证日期主页信息
classString准驾车型主页信息
valid_beginString有效期起主页信息
valid_endString有效期止主页信息

错误码

HttpCode错误码错误消息描述
20010000请求成功
40060503"Invalid Input Image: No driving license detected in input image, bad input image"输入图片没有检测到驾驶证
40150205"Image Size Exceeds Maximum Limit: please compress the image"图片大小超过上限
40050207"Image Decode Error: image format unsupported"图片解码错误,文件内容为空或格式错误
40150400"Access denied due to invalid authentication information"鉴权失败
40450402"Invalid Request URL"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误,需要联系开发人员

注: 更多通用反馈字段通用返回字段及错误码

返回值示例

主页面图片返回值示例

{
    "code":10000,
    "data":{
        "license_main":{
            "id_number":"370XXX19000101XXXX",
            "name":"张三",
            "sex":"女",
            "nationality":"中国",
            "address":"山东省XX市XX镇XX村XX",
            "date_of_birth":"1900-01-01",
            "date_of_first_issue":"2016-01-01",
            "class":"C1",
            "valid_begin":"2016-01-01",
            "valid_end":"2022-01-01"
        }
    },
    "message":"Success",
    "request_id":"68465821727368171521594094134",
    "time_elapsed":"509.475088ms"
}