/face/liveness_anti_hack

1.接口描述

该API的功能是验证采集的用户活体信息是否存在hack行为，需要结合移动端SDK使用

  • 图片要求
    1. 格式为 JPG（JPEG），BMP，PNG，GIF，TIFF
    2. 宽和高大于 128px，小于等于4000px
    3. 小于等于 5 MB

请求方式：

POST

请求URL：

http://cloudapi.deepfinch.com/face/liveness_anti_hack

调试工具

Debugging Tool

2.请求参数

2.1 请求头域

字段 类型 必需 描述
X-DF-API-ID string 是 API调用凭证信息，详细信息请参考API调用
X-DF-API-SECRET string 是 API调用凭证信息，详细信息请参考API调用

2.2 请求体

字段 类型 必需 描述
liveness_data_file file 见下方注释 活体protobuf文件
liveness_data_url string 见下方注释 活体文件的url，从网络获取时选取此参数
detect_occlusion int 否 是否启用脸部遮挡检测，默认不启用；取值：传1 为启用，0不启用。

注释：

请求参数 liveness_data_file , liveness_data_url 与 liveness_data_id 三选一。

参数 liveness_data_file 需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。

脸部遮挡检测会判断脸部眼睛、鼻子、嘴巴、下巴、额头等是否存在遮挡，请根据实际业务场景，来决定是否需要启用。

3.返回参数

正常响应 （200）

字段 类型 描述
request_id string 本次请求的 id
status string 状态。正常为 OK ，其他值表示失败。详见错误码
score float hack检测分数。取值范围是0~1。值越大，表示被hack的可能性越大
liveness_data_id string 活体文件的云端id，若使用liveness_data_file、liveness_data_url方式返回此参数
featured_image_id string 活体protobuf文件中质量最好的图片ID
has_occlusion bool 脸部是否存在遮挡，当 设置detect_occlusion请求参数为1时，才会返回此字段

> 备注：hack score阈值为0.98，由行业大数据训练得到，大于0.98是hack行为，小于等于0.98是正常活人

输出示例：

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "score": 0.999316,
  "has_occlusion": false,
  "liveness_data_id": "xxxxx",
  "featured_image_id": "xxxxxxxxxxx"
}

4.错误码

状态码 status 字段 说明
400 INVALID_ARGUMENT 请求参数错误
400 DETETION_FAILED 图片检测失败
400 DOWNLOAD_ERROR 网络地址图片获取失败
401 UNAUTHORIZED 未授权或授权失败
401 KEY_EXPIRED 账号过期
403 NO_PERMISSION 无调用权限
403 OUT_OF_QUOTA 调用次数超出限额
403 RATE_LIMIT_EXCEEDED 调用频率超出限额
404 NOT_FOUND 请求路径错误
500 INTERNAL_ERROR 服务器内部错误

输出示例：

{
  "status": "DOWNLOAD_TIMEOUT",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

results matching ""

    No results matching ""