# 身份证识别
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:idcardOcr
本接口提供身份证正反面OCR识别功能。
此接口为后台接口,可基于自有业务承载情况,搭配小程序的拍照、相册选照等一起使用,即可完成身份证照片的采集、上传、识别、信息返回等流程,用于需要基于身份证、银行卡等实体卡或证,采集照片或文字信息等的业务场景。
支持已认证的订阅号、服务号、企业号、小程序可直接调用,次数限制为100次/天。如有更高额度调用需求,可前往服务平台进行购买。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cv/ocr/idcard?access_token=ACCESS_TOKEN&img_url=IMG_URL
# 云调用
调用方法:ocr.idcard
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:117
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOCKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
img_url | string | 否 | ENCODE_URL | 要检测的图片 url,传这个则不用传 img 参数。 |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
img | formdata | 否 | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
type | string | 正面或背面,Front / Back |
name | string | 正面返回,姓名 |
id | string | 正面返回,身份证号 |
valid_date | string | 背面返回,有效期 |
addr | string | 正面返回,地址 |
gender | string | 正面返回,性别 |
nationality | string | 正面返回,民族 |
# 4. 注意事项
- 图片支持使用img参数实时上传,也支持使用img_url参数传送图片地址,由微信后台下载图片进行识别。
- 文件大小限制:小于2M
# 5. 代码示例
请求示例
curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/idcard?type=photo&access_token=ACCESS_TOCKEN”
返回示例
{
"errcode": 0,
"errmsg": "ok",
"type": "Front",
"name": "张三",
"id": "123456789012345678",
"addr": "广东省广州市XXX",
"gender": "男",
"nationality": "汉"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
-1 | system error | 系统错误 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
101000 | invalid image url | 图片URL错误 |
101001 | certificate not found | 未检测到证件 |
101002 | decode image failed | 图片大小超过限制,resp_type = 0: 2MB,resp_type = 1: 10MB |
101003 | not enough market quota |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
小程序 | 公众号 | 服务号 |
---|---|---|
✔ | 仅认证 | 仅认证 |
- ✔:该账号可调用此接口
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;