# TouchId

# fingerPrintVerification

进行生物识别(指纹/面容)验证

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
data Object 必填 api参数传入{type:''},type类型face/finger
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1:失败
message String 调用结果信息
payload Object 详细结果,详见下表
  • 返回payload参数说明
参数名 类型 说明
code Number 调用结果编码
message String 调用结果消息内容
  • 返回payload中status与message参数对照字段说明

    • 0:指纹认证通过
    • 55001:指纹信息变更
    • 55002:设备不支持指纹识别
    • 55003:系统取消授权
    • 55004:用户取消验证Touch ID
    • 55005:授权失败
    • 55006:系统未设置密码
    • 55007:设备Touch ID不可用
    • 55008:TouchID未注册
    • 55009:用户选择输入密码
    • 55010:其他情况
  • 示例代码


foxsdk.touchid.fingerPrintVerification({type:'face'},ret => {
    console.log('touchid/fingerPrintVerification===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# deviceBiometrics

获取设备支持的生物识别类型

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1:失败
message String 调用结果信息
payload Object 详细结果,详见下表
  • 返回payload参数说明
参数名 类型 说明
biometricsType Number 0不支持touchid和faceid等生物识别 ; 1支持touchid ;2支持faceid(要求系统版本>=10.0);3支持touchid和faceid
biometricsText String 调用结果消息内容
  • 示例代码

foxsdk.touchid.deviceBiometrics(ret => {
    console.log('touchid/deviceBiometrics===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

  • 备注:
  1. android在android10以后才提供faceid的检测的接口,所以设备支持不支持faceid只有在android 10上才能够得出正确结论,现在由于android10 还未适配所以不可用。

2.由于android 和ios的差异,android没有提供人脸验证的流程界面,所以即使android10 适配好以后能够检查到设备支持faceid,但也没有相对应的人脸验证流程,除非项目自设计人脸检测的流程UI,然后做开发。所以暂时将生物识别接口都改为不返回faceid的结果。

# updateTouchId

更新变更后的指纹信息,前端其他安全方式验证后调用此方法

  • 支持平台
Android IOS HarmonyOS
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数,成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 失败请查看全局码
message String 调用结果信息
  • 示例代码

foxsdk.touchid.updateTouchId(ret => {
    console.log('touchid/updateTouchId===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

Last Updated: 4/26/2024, 9:57:53 AM