Skip to content

人脸识别 - authFace ​

简介 ​

  • 通过该API可拉起APP的人脸识别功能,并返回对应的回调信息;
  • 该API是一个异步任务,可使用async await / promise结构 获取回调值;

环境适配说明 ​

环境名称是否支持jssdk文件最低版本号npm包最低版本号
湘易办APP-小程序✅1.1.40.0.4
湘易办APP-小程序-webview✅1.1.80.0.4
湘易办APP-webview✅2.0.00.0.4
三方H5❌----
三方小程序-H5✅--0.0.32

参数 ​

参数名类型必填描述
nameString✅姓名
certNoString✅证件号
appIdString✅申请人脸能力的appID
signString✅签名
createdtimestamp✅创建时间戳
nonceString✅32位随机数
callbackURLString❌人脸识别后,回跳的页面地址

返回值 ​

仅列出返回体内的子参数,整体是一个Object对象

参数名类型描述
isSuccessBoolean验证结果
certifyIdString认证ID
portraitbase64头像
errorMsgString错误信息

示例 ​

javascript
const userInfo = {
  name: '张三',
  certNo: '123456789012345678'
}
const res = await this.$xybAgent.authFace(userInfo);
if (res?.isSuccess) {
  // 执行业务代码
}
javascript
const userInfo = {
  name: '张三',
  certNo: '123456789012345678'
}
this.$xybAgent.authFace(userInfo).then(res => {
  if (res?.isSuccess) {
    // 执行业务代码
  }
})