StillLivenessImg接口--身份认证-火山引擎

文档中心

导航

StillLivenessImg接口

最近更新时间：2024.06.17 15:24:15首次发布时间：2023.06.15 16:47:50

接口简介

静默活体检测指对采集的用户人脸图片进行活体检测，判断采集的人脸照片是否是由活体采集而来。

限制条件

名称	内容
图片要求	图片格式：JPG、JPEG、PNG等常见格式，建议使用JPG格式。图片文件大小：最大 5000000Bytes。图片分辨率最大2000 x 2000像素。
视频要求	视频格式支持常见视频类型格式，建议使用mp4格式。视频链接为外网可访问链接。接口处理时长可能随输入视频体积大小增大而变长，如果你对耗时/请求成功率比较敏感，建议尽量减小输入视频体积以加快处理速度。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数	可选/必选	类型	说明
Action	必选	string	接口名，取值：StillLivenessImg
Version	必选	string	版本号，取值：2022-08-31

（3）Body参数
业务请求参数

参数	可选/必选	类型	说明
req_key	必选	string	算法名称，取固定值为"still_liveness"
binary_data_base64	可选	array of string	输入图片的base64数组，与图片链接二选一。此算法需要输入 1 张人脸图
image_url	可选	array of string	输入图片的下载链接数组，与图片的base64二选一。此数组需要输入 1 个下载链接
video_url	可选	string	输入视频的下载链接，服务将会对视频进行动作/静默活体检测后，抽取最佳帧再进行静默活体检测（传入video_url时不可同时传入binary_data_base64或image_url）
video_type	可选（传入有效video_url时为必选）	string	对输入视频的活体处理类型，可取值motion/still（分别表示动作和静默活体）
motion_list	可选（传入有效video_url且video_type为motion时，为必选）	array of number	预期完成的活体动作种类和顺序。可选动作：0：眨眼；1：张嘴；2：点头；3：摇头

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data 字段说明

字段	类型	说明
is_face_attack	string	是否为攻击。T表示是，F表示否

（3）输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": ""
        },
        "binary_data_base64": [],
        "is_face_attack": "F"
    },
    "message": "Success",
    "request_id": "2023061516420096D6E454F7E1BB0F8961",
    "status": 10000,
    "time_elapsed": "287.356357ms"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码
认证子错误码说明可参考子错误码中的"认证子错误说明"列
（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功