OCR /driverLicense

# ocr.driverLicense

> 本接口应在服务器端调用,详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。

> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`(最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)),`wx-server-sdk` >= `0.4.0`

本接口提供基于小程序的驾驶证 OCR 识别

调用方式:

- [HTTPS 调用](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/ocr/ocr.driverLicense.html#method-http)
- [云调用](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/ocr/ocr.driverLicense.html#method-cloud)



## HTTPS 调用

### 请求地址

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

### 请求参数

| 属性                                  | 类型     | 默认值 | 必填 | 说明                                                         |
| :------------------------------------ | :------- | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string   |        | 是   | [接口调用凭证](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html) |
| img_url                               | string   |        | 是   | 要检测的图片 url,传这个则不用传 img 参数。                  |
| img                                   | FormData |        | 是   | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 |

### 返回值

### Object

返回的 JSON 数据包

| 属性          | 类型   | 说明           |
| :------------ | :----- | :------------- |
| errcode       | string | 错误码         |
| errmsg        | string | 错误信息       |
| id_num        | string | 证号           |
| name          | string | 姓名           |
| sex           | string | 性别           |
| name          | string | 姓名           |
| address       | string | 地址           |
| birth_date    | string | 出生日期       |
| issue_date    | string | 初次领证日期   |
| car_class     | string | 准驾车型       |
| valid_from    | string | 有效期限起始日 |
| valid_to      | string | 有效期限终止日 |
| official_seal | string | 印章文构       |

### 使用说明

**接口限制** 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用,次数限制为100次/天。

**使用 Tips** 此接口为后台接口,可基于自有业务承载情况,搭配小程序的拍照、相册选照等一起使用,即可完成身份证照片的采集、上传、识别、信息返回等流程,用于需要基于身份证、银行卡等实体卡或证,采集照片或文字信息等的业务场景。

**图片说明** 文件大小限制:小于2M

图片支持使用 img 参数实时上传,也支持使用img_url参数传送图片地址,由微信后台下载图片进行识别。type 有两种类型

**拍摄图片样例**

![img](https://res.wx.qq.com/op_res/kD4YXjYVAW1eaQqn9uTA0rrOFoZRvVINitNDSGo5gJ7SzTCezNq_ZDDmU1I08kGn)

### 请求数据示例

示例1:

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

示例2:

```text
curl -F ‘img=@test.jpg’“http://api.weixin.qq.com/cv/ocr/drivinglicense?access_token=ACCESS_TOCKEN”
```

### 返回数据示例

```text
{
 "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市公安局公安交通管理局"
}
```



## 云调用

> [云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 `wx-server-sdk` 使用。

### 接口方法

```js
openapi.ocr.driverLicense
```

> 需在 `config.json` 中配置 `ocr.driverLicense` API 的权限,[详情](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html#usage-3)

### 请求参数

| 属性   | 类型     | 默认值 | 必填 | 说明                                                         |
| :----- | :------- | :----- | :--- | :----------------------------------------------------------- |
| imgUrl | string   |        | 是   | 要检测的图片 url,传这个则不用传 img 参数。                  |
| img    | FormData |        | 是   | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 |

**img 的结构**

| 属性        | 类型   | 默认值 | 必填 | 说明                     |
| :---------- | :----- | :----- | :--- | :----------------------- |
| contentType | string |        | 是   | 数据类型,传入 MIME Type |
| value       | Buffer |        | 是   | 文件 Buffer              |

### 返回值

### Object

返回的 JSON 数据包

| 属性         | 类型   | 说明           |
| :----------- | :----- | :------------- |
| errCode      | string | 错误码         |
| errMsg       | string | 错误信息       |
| idNum        | string | 证号           |
| name         | string | 姓名           |
| sex          | string | 性别           |
| name         | string | 姓名           |
| address      | string | 地址           |
| birthDate    | string | 出生日期       |
| issueDate    | string | 初次领证日期   |
| carClass     | string | 准驾车型       |
| validFrom    | string | 有效期限起始日 |
| validTo      | string | 有效期限终止日 |
| officialSeal | string | 印章文构       |

### 异常

### Object

抛出的异常

| 属性    | 类型   | 说明     |
| :------ | :----- | :------- |
| errCode | string | 错误码   |
| errMsg  | string | 错误信息 |

**errCode 的合法值**

| 值   | 说明 | 最低版本 |
| :--- | :--- | :------- |
|      |      |          |

### 使用说明

**接口限制** 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用,次数限制为100次/天。

**使用 Tips** 此接口为后台接口,可基于自有业务承载情况,搭配小程序的拍照、相册选照等一起使用,即可完成身份证照片的采集、上传、识别、信息返回等流程,用于需要基于身份证、银行卡等实体卡或证,采集照片或文字信息等的业务场景。

**图片说明** 文件大小限制:小于2M

图片支持使用 img 参数实时上传,也支持使用img_url参数传送图片地址,由微信后台下载图片进行识别。type 有两种类型

**拍摄图片样例**

![img](https://res.wx.qq.com/op_res/kD4YXjYVAW1eaQqn9uTA0rrOFoZRvVINitNDSGo5gJ7SzTCezNq_ZDDmU1I08kGn)

### 请求数据示例

```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
  }
}
```

或

```js
// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.ocr.driverLicense({
  type: 'photo',
  img: {
    contentType: 'image/png',
    value: Buffer
  }
})
```

### 返回数据示例

```text
{
 "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市公安局公安交通管理局"
}
```