返回值说明
优质
小牛编辑
136浏览
2023-12-01
简介
在单次活体检测(静默活体检测)中,JS SDK一共请求了三次公有云,分别是检测活体(静默活体)、请求活体关键帧图片(可选)以及防HACK检测。SDK将所有返回结果放在一个对象里面返回给开发者。
beforeCheck(data)回调函数
说明
在活体检测开始之前被调用。
data参数
Object类型,主要包含上传的视频文件。
参数 | 说明 | 类型 |
---|---|---|
video_file | 活体检测采集的视频文件,控件input[type=file] 得到 | File |
样例:
{
video_file: file
}
onCheck(data)回调函数
说明
静默/活体检测与防hack全部成功完成后,会调用该回调函数。静默/活体检测与防hack的结果会统一在该回调中返回。
data参数
Object类型,包含活体检测与防hack的结果。
参数 | 说明 | 类型 |
---|---|---|
video_file | 静默/活体检测采集的视频文件,控件input[type=file] 得到 | File |
passed | 静默/活体检测是否通过 | Boolean |
hackPassed | 后端防hack时候通过 | Boolean |
feature_image_id | 视频检测出活体的关键帧在云端的id,可以使用该id请求其他公有云接口,也可以通过公有云图片接口来浏览图片。 | String |
motions | 该属性为指定动作活体检测的结果 | Array |
liveness_score | 静默/活体检测评分 | Number |
score | 后端防hack的算法得分 | Number |
liveness_request_id | 活体检测的request_id,request_id唯一标识一次请求,主要用于排查问题 | String |
hack_request_id | 防hack的request_id,request_id唯一标识一次请求,主要用于排查问题 | String |
请参考 /liveness/check_liveness 和/hackness/hackness_selfie_hack_detect 中的返回值说明。
motions属性
参数 | 说明 | 类型 |
---|---|---|
motion | 活体检测的指定动作 | String |
score | 活体检测算法评分 | Number |
passed | 是否通过活体检测 | Boolean |
样例:
{
video_file: file,
passed: true,
hackPassed: false,
feature_image_id: "01a1cd2bc4644ae08e32ffc2cff5e8f2"
motions: [{
motion: "BLINK",
passed: true,
score: 0.7588528990745544
}],
liveness_score: 0.7588528990745544,
score: 0.3952050805091858,
liveness_request_id: "TID69e6974cf34945dea871522043ab4f29",
hack_request_id: "TID3b2a1fdea1f147bc9a76fc251b61d800"
}
onError(data)回调函数
说明
静默/活体检测或防hack失败后,会调用该回调函数,比如网络错误等。
data参数
Object类型,包含错误的信息。
参数 | 说明 | 类型 |
---|---|---|
message | 错误消息的文本 | File |
liveness_request_id | 活体检测的request_id,request_id唯一标识一次请求,主要用于排查问题 | String |
hack_request_id | 防hack的request_id,request_id唯一标识一次请求,主要用于排查问题 | String |
样例
{
message: '调用频率超出限额',
liveness_request_id: "TID69e6974cf34945dea871522043ab4f29",
hack_request_id: "TID3b2a1fdea1f147bc9a76fc251b61d800"
}