OCR 支持

OCR 插件支持身份证识别,行驶证识别和银行卡识别。

体验入口

OCR 支持 - 图1

申请权限

  • 请在小程序后台搜索本插件(AppID=wx4418e3e031e551be)设置-第三方服务-添加插件

调用方式

app.json中增加声明引入插件version选择最新的

  1. "pages": [],
  2. "plugins": {
  3. "ocr-plugin": {
  4. "version": "2.0.2",
  5. "provider": "wx4418e3e031e551be"
  6. }
  7. }
  8. }

页面的json也要增加声明

  1. {
  2. "usingComponents": {
  3. "ocr-navigator": "plugin://ocr-plugin/ocr-navigator"
  4. }
  5. }

组件

对外暴露自定义组件,UI载体为button(可样式自定义)封装了

参数

属性名类型默认值是否必填说明
onSuccessHandleEvent接口调用成功的回调函数
selectedOptionsArray插件中需要的字段,默认全部
certificateTypeStringidCard证书类型包含三种 身份证:idCard、驾驶证:drivingLicense、银行卡:bankCard

以下具体说明三种证件类型的使用方法

1、身份证

certificateType='idCard' 或 无certificateType这个参数

属性名类型默认值是否必填说明
onSuccessHandleEvent接口调用成功的回调函数
certificateTypeStringidCard证书类型包含三种 身份证:idCard、驾驶证:drivingLicense、银行卡:bankCard
oppositeBooleantrue是否显示身份证的反面,默认为 true显示反面
selectedOptionsArray插件中需要返回的字段,默认全部

selectedOptions数组支持可传的项

项目名是否必填说明
id身份证号
name姓名
sex性别
birthday出生日期
homePlace家庭地址

onSuccess

参数 e.detail

参考身份证返回结果实例

示例代码1

  1. <ocr-navigator bind:onSuccess="success" certificateType="idCard" selectedOptions="{{['id','name','sex','birthday','homePlace']}}">
  2. <button type="primary">身份证识别</button>
  3. </ocr-navigator>
  1. /** wxss **/
  2. /*自定义按钮样式*/
  3. .ocr-wrapper {
  4. margin: 40rpx auto;
  5. width: 375rpx;
  6. }
  7. .intro {
  8. margin: 40rpx;
  9. }

身份证返回结果实例

  1. {"type":"onSuccess","timeStamp":25618,"target":{"id":"","dataset":{}},"currentTarget":{"id":"","dataset":{}},"detail":{"id":"445202199706210331","name":"张三","sex":0,"birthday":"1997-06-21","homePlace":"广州市天河区五xxx路","noExpiryDate":false,"issueDate":"2011-11-02","expiryDate":"2021-11-02"}}

身份证返回结果

属性类型说明
idstring身份证号
namestring姓名
sexnumber性别 0代表男 1代表女
birthdaystring出生日期
homePlacestring家庭住址
issueDatestring身份有效开始日期
expiryDatestring身份证失效日期
noExpiryDateboolean身份证是否失效

2、银行卡

certificateType='bankCard'

属性名类型默认值是否必填说明
onSuccessHandleEvent接口调用成功的回调函数
certificateTypeStringbankCard证书类型包含三种 身份证:idCard、驾驶证:drivingLicense、银行卡:bankCard
selectedOptionsArray插件中需要返回的字段,默认全部

selectedOptions数组支持可传的项

项目名是否必填说明
bankName银行名称
number银行卡号
validDate过期时间

onSuccess

参数 e.detail

参考银行卡返回结果实例

示例代码1

  1. <ocr-navigator bind:onSuccess="bankSuccess" certificateType="bankCard" selectedOptions="{{['bankName','number','validDate']}}">
  2. <button type="primary">银行卡识别</button>
  3. </ocr-navigator>
  1. /** wxss **/
  2. /*自定义按钮样式*/
  3. .ocr-wrapper {
  4. margin: 40rpx auto;
  5. width: 375rpx;
  6. }
  7. .intro {
  8. margin: 40rpx;
  9. }

银行卡返回结果实例

  1. {"type":"onSuccess","timeStamp":163523,"target":{"id":"","dataset":{}},"currentTarget":{"id":"","dataset":{}},"detail":{"bankName":"","number":"622xxxxxxxxx","validDate":""}

银行卡返回结果

银行卡只支持横版储蓄卡,信用卡,并且只能识别出银行卡号,如果需要银行卡名称、过期时间需要用户手动输入

属性类型说明
bankNamestring银行卡名称,暂时识别不出
numberstring银行卡号
validDatestring过期时间

3、行驶证

certificateType='drivingLicense'

属性名类型默认值是否必填说明
onSuccessHandleEvent接口调用成功的回调函数
certificateTypeStringdrivingLicense证书类型包含三种 身份证:idCard、驾驶证:drivingLicense、银行卡:bankCard
selectedOptionsArray插件中需要返回的字段,默认全部

selectedOptions数组支持可传的项

项目名是否必填说明
plateNum号牌号码
vehicleType车辆类型
ownerowner
addr住址
useCharacter使用性质
model品牌型号
vin车牌识别代号
engineNum发动机号码
registerDate注册日期
name发证机关
record档案编号
passengersNum核定载人数
totalQuality总质量
prepareQuality整备质量
loadQuality核定载质量
leadQuality准牵引总质量

onSuccess

参数 e.detail

参考行驶证返回结果实例

示例代码1

  1. <ocr-navigator bind:onSuccess="driverSuccess" certificateType="drivingLicense" selectedOptions="{{['plateNum','vehicleType','owner']}}">
  2. <button type="primary">行驶证识别</button>
  3. </ocr-navigator>
  1. /** wxss **/
  2. /*自定义按钮样式*/
  3. .ocr-wrapper {
  4. margin: 40rpx auto;
  5. width: 375rpx;
  6. }
  7. .intro {
  8. margin: 40rpx;
  9. }

行驶证返回结果实例

  1. {"type":"onSuccess","timeStamp":21953,"target":{"id":"","dataset":{}},"currentTarget":{"id":"","dataset":{}},"detail":{"plateNum":"粤xxxx","vehicleType":"小型轿车","owner":"周xx","addr":"广东省xxxxx","useCharacter":"非营运","model":"东风日产牌xxxxx","vin":"xxxxx","engineNum":"873073Y","registerDate":"2017-11-13","name":"","record":"442923230932","passengersNum":"26人","totalQuality":"6900kg","prepareQuality":"4480kg","loadQuality":"","leadQuality":""}}

行驶证返回结果

行驶证支持正副页面在一张图片中

属性类型说明
plateNumString号牌号码
vehicleTypeString车辆类型
ownerStringowner
addrString住址
useCharacterString使用性质
modelString品牌型号
vinString车牌识别代号
engineNumString发动机号码
registerDateString注册日期
nameString发证机关
recordString档案编号
passengersNumString核定载人数
totalQualityString总质量
prepareQualityString整备质量
loadQualityString核定载质量
leadQualityString准牵引总质量

说明

本文档配合2.0.2以及以上的插件使用,并且调试基础库在2.4.0以及以上才能使用