开始认证

方法名

verify

用法

用法如下：

uniappuniappx

module.verify({
  params: {
    /**
     * 从服务端初始化认证接口（InitFaceVerify）获取的CertifyId
      * 每个CertifyId只能调用一次verify函数，每次调用verify函数之前务必重新获取CertifyId
      */
    certifyId: this.certifyId,
    /**
     * 当刷脸认证过程中出现异常情况，是否使用SDK内部的弹框提示。取值：
      * true：SDK先弹框提示，确定之后，返回错误code
      * false：不弹提示框，直接返回错误code，客户业务应用App自行决定如何提示
      */
    useMsgBox: false,
    //用户自定义参数，一般直接传NULL即可。目前支持的自定义字段，具体取值信息可参考插件文档
    // extParams:{},
    //自定义ui样式
    // customUIConfig: {
    //   //配置自定义入参的类型，具体类型可参考插件文档
    //   paramType: "assets",
    //   //与paramType配套调用
    //   param: "DTFConsumUIConfig.json"
    // },
    //自定义ui文案
    // customTxtConfig: {
    //   //配置自定义入参的类型，具体类型可参考插件文档
    //   paramType: "assets",
    //   //与paramType配套调用
    //   param: "DTFConsumTxtConfig.json"
    // }
  },
  complete: (res) => {
    if (res.code != 0) {
      this.showMessage("认证失败")
      return
    }
    let data = res.data || {};
    let code = data.code
    if (code == 1000) {
      this.showMessage("认证成功");
    } else {
      let retMessageSub = data.retMessageSub
      this.showMessage(retMessageSub)
    }
  }
})

module.verify({
  params: {
    /**
     * 从服务端初始化认证接口（InitFaceVerify）获取的CertifyId
     * 每个CertifyId只能调用一次verify函数，每次调用verify函数之前务必重新获取CertifyId
     */
    certifyId: this.certifyId,
    /**
     * 当刷脸认证过程中出现异常情况，是否使用SDK内部的弹框提示。取值：
     * true：SDK先弹框提示，确定之后，返回错误code
     * false：不弹提示框，直接返回错误code，客户业务应用App自行决定如何提示
     */
    useMsgBox: true,
    //用户自定义参数，一般直接传NULL即可。目前支持的自定义字段，具体取值信息可参考插件文档
    // extParams:{},
    //自定义ui样式
    // customUIConfig: {
    //   //配置自定义入参的类型，具体类型可参考插件文档
    //   paramType: "assets",
    //   //与paramType配套调用
    //   param: "DTFConsumUIConfig.json"
    // },
    //自定义ui文案
    // customTxtConfig: {
    //   //配置自定义入参的类型，具体类型可参考插件文档
    //   paramType: "assets",
    //   //与paramType配套调用
    //   param: "DTFConsumTxtConfig.json"
    // }
  },
  complete: (res : LevenResult) => {
    if (res.code != 0) {
      showMessage("认证失败")
      return
    }
    let data = res.data || {};
    let code = data.getNumber("code")!
    if (code == 1000) {
      showMessage("认证成功")
    } else {
      let retMessageSub = data.getString("retMessageSub")!
      showMessage(retMessageSub)
    }
  }
} as LevenOptions)

参数说明

参数名	参数类型	是否必填	默认值	参数描述
params	Object	是	无	参数对象
params.certifyId	String	否	无	从服务端初始化认证接口（InitFaceVerify）获取的CertifyId `每个CertifyId只能调用一次verify函数，每次调用verify函数之前务必重新获取CertifyId`
params.useMsgBox	Boolean	否	false	当刷脸认证过程中出现异常情况，是否使用SDK内部的弹框提示。取值： `true`：SDK先弹框提示，确定之后，返回错误code `false`：不弹提示框，直接返回错误code，客户业务应用App自行决定如何提示
params.extParams	Object	否	无	用户自定义参数，一般直接不传即可。目前支持的自定义字段，extParams取值，详情请参见下方extParams取值说明，对象中的值请传字符串 `金融级多因子意愿认证方案暂不支持此参数，不传即可`
params.customUIConfig	Object	否	无	自定义ui样式，具体样式文件字段定义说明请参考【官方文档】
params.customUIConfig.paramType	String	否	无	配置自定义入参的类型，取值： `assets`：传入App assets文件类型，param需要传入assets文件名称，具体用法可参考assets类型说明 `path`：传入设备本地路径，params需要传入配置文件的设备绝对路径地址 `json`：传入JSON字符串，params需传入JSON格式的数据
params.customUIConfig.param	String	否	无	与paramType配套调用
params.customTxtConfig	Object	否	无	自定义ui文案，具体样式文件字段定义说明请参考【官方文档】
params.customTxtConfig.paramType	String	否	无	配置自定义入参的类型，取值： `assets`：传入App assets文件类型，param需要传入assets文件名称，具体用法可参考assets类型说明 `path`：传入设备本地路径，params需要传入配置文件的设备绝对路径地址 `json`：传入JSON字符串，params需传入JSON格式的数据
params.customTxtConfig.param	String	否	无	与paramType配套调用
success	Function	否	无	执行成功的函数
fail	Function	否	无	执行失败的函数
complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

extParams取值说明

取值	说明	示例
ext_params_key_use_video	是否返回活体认证视频。取值： `true`：可在response.videoFilePath或在服务端查询接口获取视频本地路径。 `false`：不返回活体认证视频（默认）	false
ext_params_key_screen_orientation	认证界面UI朝向。取值： `ext_params_val_screen_port`：竖屏（默认） `ext_params_val_screen_land`：横屏	ext_params_val_screen_port
ext_params_key_face_progress_color	活体检测页面的进度条颜色	#FF0000
ext_params_key_ocr_bottom_button_color	OCR识别结果确认页底部按钮颜色	#FF0000
ext_params_key_languageFromApp	SDK自定义语言设置 `en`：英文 `in`：印度文 `ja`：日文 `ko`：韩文 `zh-CN`：中文简体 `zh-HK`：中文繁体 `zh-TW`：中文繁体其他值不支持，显示系统语言	zh-CN
ext_params_key_wave_animate_close	刷脸Loading页面UI样式是否切换转圈模式。取值： `true`：转圈模式 `false`：水波纹模式（默认）	true

assets类型说明

需要将配置文件放置到uni_modules > leven-uts-aliFace > utssdk > app-android > assets目录下，如果插件中没有assets目录您需要新建一个

回调

示例

json

{
  "data": {
    "id": "1234",
    "code": 2002,
    "extInfo": {},
    "deviceToken": "0E7WDrhoWDoZYv2dPIsGVzEXgJAvD4GUayLJmbfqMFUhgRqMngEAAA==",
    "retMessageSub": "刷脸认证服务报错（Z1043)",
    "reason": "Z1043"
  },
  "message": "",
  "code": 0
}

回调说明：

参数名	参数类型	参数描述
message	String	消息提示
data	Object	数据对象
data.id	String	认证结果响应id
data.code	String	认证结果code
data.extInfo	Object	认证结果扩展信息
data.deviceToken	String	认证结果设备token
data.retMessageSub	String	认证结果描述
data.reason	String	认证结果原因，可参考【官方文档处理结果】
code	Integer	返回类型，0.成功，其他：失败

开始认证 ​

方法名 ​

用法 ​

extParams取值说明 ​

assets类型说明 ​

回调 ​

开始认证

方法名

用法

extParams取值说明

assets类型说明

回调