# 身份证识别

接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

# 接口说明

# 接口英文名

idCardOCR

# 功能描述

本接口提供基于小程序的身份证 OCR 识别

# 注意事项

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

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/cv/ocr/idcard?access_token=ACCESS_TOKEN 

# 云调用

  • 出入参和HTTPS调用相同,调用方式可查看云调用说明文档

  • 接口方法为: openapi.ocr.idcard

# 请求参数

属性 类型 必填 说明
access_token / cloudbase_access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。access_token和cloudbase_access_token二选一
其中access_token可通过getAccessToken接口获得;
cloudbase_access_token可通过getOpenData接口获得
img_url string 要检测的图片 url,传这个则不用传 img 参数。
img FormData form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。

# 返回参数

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
type string 正面或背面,Front / Back
name string 正面返回,姓名
id string 正面返回,身份证号
valid_date string 背面返回,有效期
addr string 正面返回,地址
gender string 正面返回,性别
nationality string 正面返回,民族

# 调用示例

示例说明: 正面示例

# 请求数据示例


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": "广东省广州市",
  "gender": "男",
  "nationality": "汉"
} 

示例说明: 反面示例

# 请求数据示例


curl https://api.weixin.qq.com/cv/ocr/idcard?type=photo&img_url= ENCODE_URL&access_token=ACCESS_TOCKEN 

# 返回数据示例


{
 "errcode": 0,
 "errmsg": "ok",
 "type": "Back",
 "valid_date": "20070105-20270105"
} 

# 错误码

错误码 错误码取值 解决方案
-1 system error 系统繁忙,此时请开发者稍候再试
40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
101000 invalid image url
101001 certificate not found
101002 decode image failed
101003 not enough market quota