UDYhy

来自于:有盾云慧眼立即使用

云慧眼产品接入

开发者在使用有盾云慧眼产品的时候,需要联系有盾市场人员开通服务,并获取pubkey值,方可使用云慧眼产品。分为以下步骤:

1.联系有盾

开发者在使用有盾云慧眼的模块时,需要开发者进入有盾官网最底部点击"在线申请",留下您的信息并会与我们取得联系。

2.对接

产品开通后,pubkey值、有盾商户站地址、账号密码均会以邮件的形式发送给商户,商户可以登录有盾商户站去下载提供的测试demo。

3.开始对接

商户在APICloud官网导入我司的模块(模块名:UDYhy),打包编译并使用。另外,产品开通之后,我司的技术会和商户技术建QQ群,确保第一时间为商户解决使用中遇到的问题。

说明:编译时候的固件版本安卓要求4.0.3以上,IOS要求8.0以上

云慧眼功能服务

  • OCR身份证识别:自动扫描用户身份证,获取身份证上8个结构化字段信息,并截取头像照片。
  • 活体检测:随机交互式动作,验证用户为真人操作,并截取质量检测合格的人脸图片。
  • 实名认证:对用户姓名与身份证号码通过公民信息查询服务中心进行一致性验证。
  • 人脸比对:实名验证一致的用户,进行身份证照片、活体照片、预留照片双重一致性比对,两次比对通过方可认证成功。

云慧眼模块概述

本模块封装了有盾云慧眼原生 SDK,集成了ocr身份证识别、活体检测;专注于人工智能创新学习,结合云计算深度分析验证用户身份和行为,全面预防互联网用户身份欺诈风险;轻松、高效集成云慧眼到自己的 App 内。

功能接口调用

全流程功能UI界面图

身份证OCR识别UI页面、姓名核验UI页面、活体UI页面如下:

  • 注:如全流程功能UI界面图所示,参考节调用方法,成功调用出现OCR”身份证扫描”界面扫描身份证,OCR完成确认扫描信息后进入活体检测”人脸认证”界面。该流程UI界面等已封装,商户可按流程完成操作无须自定义

    调用步骤

  • 引入云慧眼模块 UDYhy

  • 调用与回调方法,全流程:runFaceAuth(),调用示例如下

    // 1.云慧眼全流程
    function runFaceAuth() {
        var demo = api.require('UDYhy');
        demo.faceAuth({
                       authKey: 'xxxx-xxxx-xxxx-xxxx', // authKey 不能为空
                       outOrderId: '12345',            // 订单号不能为空(建议传时间戳+后缀的形式)
                       notifyUrl: 'www.xxx.com'        // 异步通知地址可选
        },function(ret, err){
                       // 获取云慧眼回调方法
                       if (err) {
                            // authKey 或者 outOrderId 为空会走这个回调
                            alert(JSON.stringify(err));
                       } else {
                            if (ret.ret_code === '000000') {
                                // 请求成功
                                alert(JSON.stringify(ret));
                                if (ret.result_auth === 'T') {
                                    // 人脸认证通过
                                }
                            } else {
                                // 发生错误
                                alert(JSON.stringify(ret));
                            }
                       }
        });
    }

设置项

参数名 名称 必传 类型 描述
outOrderId 商户唯一订单号 Y String 此参数由商户自行生成,建议传入时保证唯一性并做留存,以便后期直接定位具体订单
格式要求:长度不超过36位,且不包含:_#_等特殊字符特殊符号
authKey 认证key值 Y String 商户认证key值(对应下发邮件中的pubkey值)
notifyUrl 结果异步通知地址 N String 接收推送信息的地址

返回结果

结果示例

{
    "addr_card":"浙江省杭州市滨江区越达巷",
    "be_idcard":"0.9805",
    "branch_issued":"滨江公安局",
    "date_birthday":"1990.04.12",
    "flag_sex":"男",
    "id_name":"周伯通",
    "id_no":"320421199011120054",
    "result_auth":"T",
    "result_status":"01",
    "url_frontcard":"https://idsafe-auth.udcredit.com/front/4.0/api/file_download/....",
    "url_backcard":"https://idsafe-auth.udcredit.com/front/4.0/api/file_download/....",
    "url_photoget":"https://idsafe-auth.udcredit.com/front/4.0/api/file_download/....",
    "url_photoliving":"https://idsafe-auth.udcredit.com/front/4.0/api/file_download/....",
    "risk_tag": {
       "living_attack": "0"
    },
    "state_id":"汉",
    "start_card":"2017.02.03-2037.02.03",
    "ret_msg":"操作成功",
    "ret_code":"000000"
}

参数列表

参数名称 字段名称 类型 描述
be_idcard 人脸比对相似度 String 该字段为2张用户照的比对结果,值在0到1之间
注:当result_auth为T时该字段必返,
为F时该字段value为0(为方便商户做逻辑判断返回为0,不具有实际意义)
result_auth 认证结果 String T:认证通过(相似度>0.7且实名人像比对结果为01)
F:认证未通过
result_status 实名人像比对结果 String 该字段为用户照与公安网预留照片的比对结果,在进行比对之前会
先进行身份证号码和身份证姓名的一致性验证,
当实名认证一致时(verify_status为1,该字段服务端返回)必返
01:系统判断为同一人
02:系统判断为不同人
03:不能确定是否为同一人
04:系统无法比对(公安网系统无法比对)
05:库中无照片(公安库中没有网格照)
id_no 身份证号码 String 若交易成功,必传
id_name 身份证姓名 String 若交易成功,必传
state_id 民族 String 若交易成功,必传
flag_sex 性别 String 若交易成功,必传
date_birthday 生日 String 若交易成功,必传
start_card 证件有效期 String 若交易成功,必传
addr_card 证件地址 String 若交易成功,必传
branch_issued 签发机构 String 若交易成功,必传
url_frontcard 身份证人像面照下载地址 String 下载地址7天内有效
url_backcard 身份证国徽面照下载地址 String 下载地址7天内有效
url_photoget 身份证头像照下载地址 String 下载地址7天内有效
url_photoliving 活体照下载地址 String 下载地址7天内有效
risk_tag 风险标签 String JSON对象,living_attack表示是否存在活体攻击风险,
living_attack字段值:
0:未检测到活体攻击;
1:存在活体攻击风险;
该字段指活体验证过程中是否存在预制视频、视频翻拍、照片、模型面具等攻击行为的检测结果,
1:表示存在极大概率攻击行为,0:表示暂未检测出风险(会有一定概率漏检或误判情况),
建议商户在业务决策中把该字段作为判断参考条件之一
classify 五分类检测 String 0:复印件
1:PS证件
2:正常证件
3:屏幕翻拍
4:临时身份证
5:其他
注:当识别不出证件时,会返回5--其他,可能存在漏检或误判的情况
若调用失败或异常不返回该字段
ret_code 认证结果代码 String 如000000,见返回码
ret_msg 认证结果描述 String 如“交易成功”

状态码

返回码 含义 返回信息
000000 交易成功 交易成功
100001 内容解密失败 请求参数错误,请联系客服
100002 请求参数校验错误 请求参数错误,请联系客服
100004 商户签名错误 请求参数错误,请联系客服
200002 图片或视频上传出错 请求处理失败,请重新操作
200004 商户鉴权失败:如商户不存在 请求处理失败,请联系客服
200005 产品配置异常:如未开通此产品权限 请求处理失败,请联系客服
200007 IP不在白名单内,请联系运营人员配置 请求处理失败,请联系客服
200008 商户账户资金超透支、商户账户已冻结 请求处理失败,请联系客服
200011 请求处理失败,App应用标识未在配置白名单,请检查 请求处理失败,请联系客服
200012 请求处理失败,未配置App应用标识启用规则,请联系客服 请求处理失败,请联系客服
410003 身份证反面识别出错 图像无法识别,请重试
410004 身份证正面识别出错 图像无法识别,请重试
410006 身份证已过期,请更换证件 身份证已过期,请更换证件
500003 接口异常 网络异常,请重试
500006 身份证姓名和身份证号查询无结果 查询不到用户身份信息
500007 身份证姓名和身份证号码不一致 姓名和身份证号码不一致
500014 身份证姓名和身份证号码一致,但查询不到照片 姓名和身份证号码一致,但查询不到照片
500015 人脸特征提取失败 请求处理失败,请联系客服
700001 文件下载处理出错,请重试 文件下载处理出错,请重试
700003 对应文件不存在 对应文件不存在
700005 文件下载地址已过期(下载地址7天内有效) 文件下载地址已失效
700006 文件已损坏 文件已损坏
999999 系统异常 请求处理失败,请联系客服
900001 用户取消操作 用户取消操作
900002 网络异常 网络异常,连接服务器失败
900004 姓名不符合规范 您提供的姓名不符合规范,请重新传入
900006 参数校验错误 商户请求参数校验错误[%s]
900007 接口异常,请联系客服 接口异常,请联系客服
900008 authKey不能为空 请输入开户有效的pub_key
900012 人脸检测超时,请重新操作 人脸检测超时,请重新操作
900013 检测不到人脸,请重新操作 检测不到人脸,请重新操作
900014 人脸检测频繁失败,请重新操作 人脸检测频繁失败,请重新操作

说明:当SDK端返回的be_idcard或服务端返回的similarity值>0.7且result_status为01时,SDK端返回的result_auth或服务端返回的auth_result为T,其他情况都为F,商户可根据实际业务需求来封装判断逻辑

注:SDK端返回的相似度和认证结果与服务端字段名虽不同,但皆为同一个值,其他如民族、性别等字段同理。