xinyanOCR
configuration startBankCardScan
论坛示例
为帮助用户更好更快的使用模块,论坛维护了一个,示例中包含示例代码、知识点讲解、注意事项等,供您参考。
概述
xinyanOCR是新颜提供的专注于识别互联网用户身份真实性的产品,支持身份证识别和银行卡识别。由于XYOCRSDK付费,使用之前需要和新颜科技的技术支撑联系,开通SDK,并注册应用。
- 身份证识别:支持对大陆居民二代身份证正反面的所有字段进行结构化识别,包括姓名、性别、民族、出生日期、住址、身份证号、签发机关、有效期限;同时,支持对用户上传的身份证图片进行图像风险和质量检测,可识别图片是否为复印件或临时身份证,是否被翻拍或编辑,是否存在正反颠倒、模糊、欠曝、过曝等质量问题。
- 银行卡识别:识别银行卡并返回卡照片、卡号、发卡行和卡片类型。
官网:
电话:400-9556-888 传真:021-68811007
邮箱:service@xinyan.com
运行环境
编译时候的固件版本安卓要求4.1.2以上,IOS要求8.0以上
在集成此模块之前需先配置config.xml文件。在config里添加如下字段:
- 名称:xinyanOCR
- 参数:memberId、terminalId、license
- 配置示例:
- 字段描述:
memberId:商户号,开通SDK后,新颜提供给商户的唯一编号
license:商户的license,license和bundle ID、商户号、终端号绑定唯一,请提前找新颜技术支持申请
configuration
配置‘OCR’SDK
configuration({params})
params
openRiskRecognition:
- 类型:布尔类型
- 描述:是否开启风险识别
- 说明:字段非必填,不填默认false
backUrl:
- 类型:字符串类型
- 描述:商户回调地址,如果需要结果异步通知到用户指定URL地址,需要设置该地址
- 说明:字段非必填,不填默认为空
示例代码
//自定义模块配置项
demo.configuration({
openRiskRecognition : false,// 是否开启风险识别
backUrl:""
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
startIDCardScan
开始身份证识别
transId:
- 类型:字符串
- 描述:商户订单号,是商户对这一笔交易的唯一编码,最长允许64位
- 说明:字段必填,不填会返回错误信息msg
callback(ret, err)
ret:
- 类型:JSON 对象
内部字段:
responseCode
- 类型:字符串
- 描述:响应码
- 说明:为00000,则表示查询成功。具体可参见[响应码表](#a4)
- idCardInfo详细信息:
idCardInfo: { //JSON对象
idcard_birthday: , //生日(正面信息),字符串
idcard_address: , //住址(正面信息),字符串
idcard_number: , //公民身份证号(正面信息),字符串
idcard_authority: , //签发机关(背面信息),字符串
idcard_nation: , //名族(正面信息),字符串
idcard_name: , //姓名(正面信息),字符串
idcard_gender: , //性别(正面信息),字符串
idcard_front_image: , //身份证正面照照片,base64
idcard_back_image: //身份证背面照照片,base64
}
调用身份证识别示例代码
var demo = api.require('xinyanOCR');
//开启身份证识别
demo.startIDCardScan({
},function(ret,err){
var msg = ret.responseDesc;
var objToStr = JSON.stringify(ret);
//打印返回的报文
console.log(objToStr);
//toast结果展示
api.toast({
location: 'middle'
});
startBankCardScan
开始银行卡识别
startBankCardScan({params}, callback(ret, err))
params
transId:
- 类型:字符串
- 描述:商户订单号,是商户对这一笔交易的唯一编码,最长允许64位
- 说明:字段必填,不填会返回错误信息msg
ret:
- 类型:JSON 对象
内部字段:
responseDesc
- 类型:字符串
- 描述:响应码对应的内容描述
bankCardInfo
- 类型:JSON 对象
- 描述:银行卡信息,详见'bankCardInfo详细信息'
- bankCardInfo详细信息:
bankCardInfo: { //JSON对象
bank_card_no: , //银行卡号
bank_card_type:, // 银行卡类型
bank_name:, // 银行卡名字
bank_card_image:, // 银行卡照片