UIFaceIDPlus

来自于:小明立即使用

startDetect getSdkVersion getSdkBuildInfo

概述

UIFaceIDPlus简介

UIFaceIDPlus 封装了FACE++SDK的身份验证(人脸核身/人脸对比对)功能。FaceID 身份验证服务提供了“我是我”的真人核验能力,通过姓名、身份证号、人脸识别、活体验证等多种手段来有效的核实使用者的身份,有效防止身份冒用、欺诈等风险。faceid平台地址

使用说明

  • 客户完成企业认证后,创建API key
  • 客户Server按照规则生成签名,通过faceid—GetBizToken(详细请查看faceid—文档—GetBizToken)接口获取biz_token后,客户App调用SDK(详细接口文档参考face++官方接口描述)。

    1. POST https://api.megvii.com/faceid/v3/sdk/get_biz_token
  • 使用UIFaceIDPlus模块打开UI页面,用户按照页面的提示,进行点头,摇头,眨眼等动作活体验证

  • 动作通过后,SDK会返回识别结果
  • 身份验证的结果会通过模块回调接口返回给开发者,同时给到客户Server,客户Server可以通过API进行认证识别后续操作
  • 在iOS端需勾选相机的权限,否则会导致崩溃

UIFaceIDPlus - 图1

不能同时使用的模块:faceidCard

模块接口

startDetect(异步接口)

打开face++的身份验证(人脸核身/人脸比对)界面

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

params

bizToken:

  • 类型:字符串
  • 描述:(必填项)调用GetBizToken接口获取的biz_token

language:

  • 类型:数字型
  • 描述:(可选项)语言选择(0:zh(中文) 1:en(英文))
  • 默认值:0

detectionType:

  • 类型:数字型
  • 描述:(可选项)活体检测手机垂直检测类型(1:仅在开始的2s内启用,2s后关闭该功能 2:持续启用 3:禁用)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true, //布尔型;true||false
  3. token : '', //用户进行活体检测业务串号
  4. data : '' //活体检测结果
  5. }

err:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. code: '',
  3. msg: ''
  4. }

示例代码

  1. var UIFaceIDPlus = api.require('UIFaceIDPlus');
  2. UIFaceIDPlus.startDetect({
  3. bizToken : 'xxxxxxx',
  4. language : 0,
  5. detectionType : 1
  6. },function(ret, err) {
  7. alert(JSON.stringify(ret));
  8. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getSdkVersion(同步接口)

获取的SDK版本号

getSdkVersion()

return

ret:

  • 类型:字符串

示例代码

  1. var UIFaceIDPlus = api.require('UIFaceIDPlus');
  2. var version = UIFaceIDPlus.getSdkVersion();
  3. alert(version);

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getSdkBuildInfo(同步接口)

获取的SDK构筑信息

getSdkBuildInfo()

return

ret:

  • 类型:字符串

示例代码

  1. var UIFaceIDPlus = api.require('UIFaceIDPlus');
  2. var buildInfo = UIFaceIDPlus.getSdkBuildInfo();
  3. alert(buildInfo);

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本