# 驾驶证识别

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：drivinglicenseocr

本接口用于驾驶证识别

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cv/ocr/drivinglicense?access_token=ACCESS_TOCKEN&img_url=ENCODE_URL
```

### 云调用

- 调用方法：ocr.driverLicense

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：117

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOCKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/subscription/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  },
  {
    "参数名": "img_url",
    "类型": "string",
    "必填": "否",
    "示例": "ENCODE_URL",
    "说明": "要检测的图片 url，传这个则不用传 img 参数。"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "img",
    "类型": "formdata",
    "必填": "是",
    "说明": "form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "id_num",
    "类型": "string",
    "说明": "证号"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "姓名"
  },
  {
    "参数名": "sex",
    "类型": "string",
    "说明": "性别"
  },
  {
    "参数名": "address",
    "类型": "string",
    "说明": "地址"
  },
  {
    "参数名": "birth_date",
    "类型": "string",
    "说明": "出生日期"
  },
  {
    "参数名": "issue_date",
    "类型": "string",
    "说明": "初次领证日期"
  },
  {
    "参数名": "car_class",
    "类型": "string",
    "说明": "准驾车型"
  },
  {
    "参数名": "valid_from",
    "类型": "string",
    "说明": "有效期限起始日"
  },
  {
    "参数名": "valid_to",
    "类型": "string",
    "说明": "有效期限终止日"
  },
  {
    "参数名": "official_seal",
    "类型": "string",
    "说明": "印章文构"
  }
]
```

## 4. 注意事项

- 支持已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为100次/天。
- 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。
- 图片说明 ，文件大小限制：小于2M
- 图片支持使用img参数实时上传，也支持使用img_url参数传送图片地址，由微信后台下载图片进行识别。type 有两种类型

## 5. 代码示例

### 5.1 上传文件请求

请求示例

``` bash
curl -F 'img=@test.jpg' 'https://api.weixin.qq.com/cv/ocr/drivinglicense?access_token=ACCESS_TOCKEN'
```

返回示例

``` json
{
    "errcode": 0,
    "errmsg": "ok",
    "id_num": "660601xxxxxxxx1234", //证号
    "name": "张三", //姓名
    "sex": "男", //性别
    "nationality": "中国", //国籍
    "address": "广东省东莞市xxxxx号", //住址
    "birth_date": "1990-12-21", //出生日期
    "issue_date": "2012-12-21", //初次领证日期
    "car_class": "C1", //准驾车型
    "valid_from": "2018-07-06", //有效期限起始日
    "valid_to": "2020-07-01", //有效期限终止日
    "official_seal": "xx市公安局公安交通管理局" //印章文字
}
```

### 5.2 上传链接请求

请求示例

``` bash
curl https://api.weixin.qq.com/cv/ocr/drivinglicense?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN
```

返回示例

``` json
{
    "errcode": 0,
    "errmsg": "ok",
    "id_num": "660601xxxxxxxx1234", //证号
    "name": "张三", //姓名
    "sex": "男", //性别
    "nationality": "中国", //国籍
    "address": "广东省东莞市xxxxx号", //住址
    "birth_date": "1990-12-21", //出生日期
    "issue_date": "2012-12-21", //初次领证日期
    "car_class": "C1", //准驾车型
    "valid_from": "2018-07-06", //有效期限起始日
    "valid_to": "2020-07-01", //有效期限终止日
    "official_seal": "xx市公安局公安交通管理局" //印章文字
}
```

### 5.3 云函数调用示例

请求示例

``` js
const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.ocr.driverLicense({
        "type": 'photo',
        "imgUrl": 'ENCODE_URL'
      })
    return result
  } catch (err) {
    return err
  }
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "id_num": "660601xxxxxxxx1234",
  "name": "张三",
  "sex": "男",
  "nationality": "中国",
  "address": "广东省东莞市xxxxx号",
  "birthDate": "1990-12-21",
  "issueDate": "2012-12-21",
  "carClass": "C1",
  "validFrom": "2018-07-06",
  "validTo": "2020-07-01",
  "officialSeal": "xx市公安局公安交通管理局"
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "101000",
    "错误描述": "invalid image url",
    "解决方案": ""
  },
  {
    "错误码": "101003",
    "错误描述": "not enough market quota",
    "解决方案": ""
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "公众号": "仅认证",
    "服务号": "仅认证"
  }
]
```

- ✔：该账号可调用此接口。
- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。
