xinyanIDVerification

• Method

configuration startActiveVerify startPassiveVerify

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

xinyanIDVerification是新颜提供的专注于识别互联网用户身份真实性的产品。通过前端用户人脸活体识别验证，以用户为中心，验证用户的真实性，全面预防互联网用户身份欺诈风险。

xinyanIDVerification可应用于运营商业务办理、银行自助业务办理、互联网用户注册认证、现金贷平台用户注册认证、借款申请审核等环节。使用本模块需在线云编译安装包或自定义 loader 使用。由于XYIDVerification SDK付费，使用之前需要和新颜科技的技术支撑联系，开通SDK，并注册应用。联系方式如下：

官网：https://www.xinyan.com/
电话：400-9556-888 传真：021-68811007
邮箱：service@xinyan.com

运行环境

编译时候的固件版本安卓要求4.1.2以上，IOS要求8.0以上

在集成此模块之前需先配置config.xml文件。在config里添加如下字段：

• 名称：xinyanIDVerification
• 参数：memberId、terminalId、ios_license、android_license
• 配置示例:

  <feature name="xinyanIDVerification">
    <param name="memberId" value="**************" />
    <param name="terminalId" value="**************" />
    <param name="ios_license" value="**************" />
    <param name="android_license" value="**************" />
  </feature>

• 字段描述：

memberId：商户号，新颜提供给商户的唯一编号

terminalId：终端号，新颜提供给商户的AES终端编号

ios_license：iOS对应的商户license

android_license：android对应的商户license

license和bundle ID、商户号、终端号绑定唯一，请提前找新颜技术支持申请。

模块接口

configuration

配置智能人身核查SDK

configuration({params})

params

editable：

• 类型：布尔类型
• 描述：设置身份信息页面是否可编辑
• 说明：字段非必填，不填默认为不可编辑

showResult：

• 类型：布尔类型
• 描述：是否展示智能人身核查结果页
• 说明：字段非必填，不填默认为展示

takePhoto：

• 类型：布尔类型
• 描述：OCR手动拍照识别功能
• 说明：字段非必填，不填默认是没有手动拍照入口

playSound：

• 类型：布尔类型
• 描述：是否播放语音提示
• 说明：字段非必填，不填默认是播放语音提示

backUrl：

• 类型：字符串
• 描述：推送回调地址,如果需要结果异步通知到用户指定URL地址，需要设置该地址
• 说明：字段非必填

identityVerification：

• 类型：布尔类型
• 描述：是否开启实名认证
• 说明：字段非必填，不填就不开启实名认证。该参数只在startPassiveVerify才起作用

openRiskRecognition：

• 类型：布尔类型
• 描述：OCR是否开启风险识别
• 说明：字段非必填，不填默认是不开启风险识别的

示例代码

var demo = api.require('xinyanIDVerification');
demo.configuration({
                      editable : false,
                      showResult : true,
                      takePhoto : true,
                      playSound : true,
                      backUrl : '**************',
                      identityVerification : false,
                      openRiskRecognition : true
                      });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本，其中1.0.1及其以下的模块，该方法中的入参needRadarInfo、phoneNo、needDeviceInfo，已废弃，暂停相关服务。

startActiveVerify

开始有源人身核查

startActiveVerify({params}, callback(ret, err))

params

transId：

• 类型：字符串
• 描述：商户订单号，是商户对这一笔交易的唯一编码，最长允许64位
• 说明：字段必填，不填会返回错误信息msg

callback(ret, err)

ret：

• 类型：JSON 对象

• 内部字段：

    responseCode
    - 类型：字符串
    - 描述：响应码
    - 说明：为00000，则表示查询成功。具体可参见[响应码表](#a4)

    responseDesc
    - 类型：字符串
    - 描述：响应码对应的内容描述
    result
    - 类型：JSON 对象
    - 描述：具体内容见result说明

result：

• 类型：JSON 对象

• 内部字段：

    idCardInfo
    - 类型：JSON 对象，具体见示例
    - 描述：身份证信息结果集
    - 说明：身份证认证成功有值
    livenessInfo
    - 类型：JSON 对象，具体见示例
    - 描述：人像核查结果集
    - 说明：人像核查成功有值

• 示例：

{
    responseCode: ,           //响应码,字符串
    responseDesc: ,           //响应码对应的内容描述,字符串
    idCardInfo: {        //JSON对象
        idcard_birthday: ,     //生日(正面信息),字符串
        idcard_address: ,      //住址(正面信息),字符串
        idcard_number: ,       //公民身份证号(正面信息),字符串
        idcard_authority: ,    //签发机关(背面信息),字符串
        idcard_nation: ,       //名族(正面信息),字符串
        valid_date: ,          //签发日期-截止日期(背面信息),字符串
        idcard_name: ,         //姓名(正面信息),字符串
        idcard_gender: ,       //性别(正面信息),字符串
        idcard_front_image: ,  //身份证正面照照片,base64
        idcard_back_image:     //身份证背面照照片,base64
    },
    livenessInfo: {     //JSON对象
        code: ,                //识别结果，,字符串。0：信息⼀致，认证成功；1：认证信息不一致；2：认证信息不存在；3：照片对比不一致；4：证件照不存在；5：人脸特征提取失败；6：认证异常；9：其它异常
        desc: ,                //描述
        score: ,               //相识度评分,字符串
        level1: ,              //level1评分,字符串
        level2: ,              //level2评分,字符串
        id_no: ,               //公民身份证号,字符串
        id_name: ,             //姓名,字符串
        fee: ,                 //是否收费,字符串
        image:                 //人脸识别图片,base64
    }
}

示例代码

var demo = api.require('xinyanIDVerification');
demo.startActiveVerify({
                       transId:'******************'
                       },function(ret,err){
                       var msg =  ret.responseDesc;
                       var objToStr = JSON.stringify(ret);
                       console.log(objToStr);
                       api.toast({
                                 msg: msg,
                                 location: 'middle'
                                 });
                       });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本，其中1.0.1及其以下的模块，该方法返回的result结果集中不再包含radarInfo、deviceInfo

startPassiveVerify

开始无源人身核查

startPassiveVerify({params}, callback(ret, err))

params

transId：

• 类型：字符串
• 描述：商户订单号，是商户对这一笔交易的唯一编码，最长允许64位
• 说明：字段必填，不填会返回错误信息msg

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：数据结构同有源人身核查

{
    responseCode: ,           //响应码,字符串。00000：查询成功！
    responseDesc: ,           //响应码对应的内容描述,字符串
    idCardInfo: {        //JSON对象
        idcard_birthday: ,     //生日(正面信息),字符串
        idcard_address: ,      //住址(正面信息),字符串
        idcard_number: ,       //公民身份证号(正面信息),字符串
        idcard_authority: ,    //签发机关(背面信息),字符串
        idcard_nation: ,       //名族(正面信息),字符串
        valid_date: ,          //签发日期-截止日期(背面信息),字符串
        idcard_name: ,         //姓名(正面信息),字符串
        idcard_gender: ,       //性别(正面信息),字符串
        idcard_front_image: ,  //身份证正面照照片,base64
        idcard_back_image:     //身份证背面照照片,base64
    },
    livenessInfo: {     //JSON对象
        code: ,                //识别结果,字符串。0：亲，认证成功；3：亲，照片对比不一致；9：其它异常
        desc: ,                //描述
        score: ,               //相识度评分,字符串
        level1: ,              //level1评分,字符串
        level2: ,              //level2评分,字符串
        id_no: ,               //公民身份证号,字符串
        id_name: ,             //姓名,字符串
        fee: ,                 //是否收费,字符串
        image:                 //人脸识别图片,base64
    }
}

示例代码

var demo = api.require('xinyanIDVerification');
demo.startPassiveVerify({
                        transId:'*******************'
                        },function(ret,err){
                        var msg =  ret.responseDesc;
                        var objToStr = JSON.stringify(ret);
                        console.log(objToStr);
                        api.toast({
                                  msg: msg,
                                  location: 'middle'
                                  });
                        });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本，其中1.0.1及其以下的模块，该方法返回的result结果集中不再包含radarInfo、deviceInfo

响应码

查询成功

验证错误

服务错误