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

文档中心

立即注册

导航

Auth接口

最近更新时间：2023.08.28 17:26:26首次发布时间：2023.07.02 09:30:25

接口简介

业务侧可通过此接口获取活体认证动作序列，并按照动作序列提示客户进行认证视频录制。在认证失败后，可以进行重试，再次调用该接口获取新的动作列表。

限制条件

无

请求说明

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

请求参数
（1）header请求参数
公共请求参数

名称	类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	使用UTC标准时间，日期精确到秒，格式：YYYYMMDD'T'HHMMSS'Z'。
Authorization	String	是	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}	HMAC-SHA256：签名方法 Credential：签名凭证，其中， -AccessKeyId是访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate是请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201 -Region默认为cn-north-1 -Service默认为cv SignedHeaders是参与签名计算的头部信息，content-type 和 host 为必选头部 Signature是签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入
X-Security-Token	String	否	无	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken： 1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问（长期 Token），无需填写该参数。 2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程：先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。

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

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

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

字段名	类型	必选/可选	说明	备注
req_key	string	必选	此处请填写`cert_auth`
byted_token	string	必选	本次核验的唯一token

输出说明

（1）通用输出参数
请参考通用返回字段及错误码

（2）业务输出参数
data 字段说明

字段名	类型	必选/可选	说明	备注
liveness_timeout	string	必选	动作活体超时时间	取值见token接口设置
motion_types	string	必选	动作列表	取值见token接口设置
remaining_retry	string	必选	重试次数	取值见token接口设置
beauty_intensity	string	必选	美颜强度	可选值：[0, 100]，默认：0
liveness_config	array of json	必选	动作活体配置项

liveness_config说明

参数名	枚举值	数据类型	默认参数	参数	参数含义
ACTION_LIVENESS_RESET	0	int		1	重置活体检测
ACTION_LIVENESS_TIME_PER_ACTION	1	float	15	服务端下发	每个动作允许时间，单位为秒
ACTION_LIVENESS_ACTION_LIST	2	int	15，四个动作	默认为“点头”，也走下发	需要完成的动作序列，00001111 0 = "眨眼", 1 = "张嘴", 2 = "点头", 3 =“摇头”
ACTION_LIVENESS_RANDOM_ORDER	7	int	True	0	随机顺序模式，默认开启
ACTION_LIVENESS_DETECT_ACTION_NUMBER	9	int	4	默认为1，也走下发	实际需要检测的动作数量.默认为4
ACTION_LIVENESS_TIME_BTW_ACTION	11	float	1.0	无	动作切换的时间间隔，默认为1.0
ACTION_LIVENESS_STILL_LIVENESS_THRESH	13	float	-2.6	无	内部静默活体的阈值，730之后端上不再包含静默，730前阈值默认为-2.6
ACTION_LIVENESS_FACE_SIMILARITY_THRESH	14	float	0.60	无	内部人脸识别的阈值，默认为0.60
ACTION_LIVENESS_MASK_RADIUS_RATIO	15	float	0.375	0.416	活体圆圈半径相对于整个屏幕宽度的占比，适配任意尺寸的图像输入，默认是0.375
ACTION_LIVENESS_OFFSET_TO_CENTER_RATIO	16	float	0.37	0.5	圆圈中心位置到顶部距离/整个屏幕高度，适配任意尺寸的图像输入，默认是0.37
ACTION_LIVENESS_TIME_FOR_WAIT_FACE	17	int	20	无	允许的最大等待人脸时间
ACTION_LIVENESS_FACE_OCCUPY_RATIO	18	float	0.12	无	用于控制人脸占比的参数，影响检测距离，目前默认参数实际大概为一臂距离
ACTION_LIVENESS_DEBUG_MODE	20	int	false	无	默认关闭
ACTION_LIVENESS_CONTINUOUS_MODE	21	int	false	无	连续且严格的动作检测，可以理解为安全模式，默认关闭。
ACTION_LIVENESS_MAX_LOSE_NUMBER	22	int	10000	无	人脸最大丢失次数,目前不限制丢失
ACTION_LIVENESS_WRONG_ACTION_MODE	23	int	false	无	是否需要做错动作检测，默认关闭
ACTION_LIVENESS_WRONG_ACTION_INVALID_TIME	24	float	1.0	无	在新动作前的x秒内不进行做错动作检测
ACTION_LIVENESS_ROTATE_FLAG	25	int	0	无，可走下发控制	控制内部是否对图片根据手机朝向做旋转
ACTION_LIVENESS_SAFE_MORE	26	int	0	实名不指定，下发为1	是否使用更安全的眨眼算法
ACTION_LIVENESS_MASK_MODE	27	int	0	实名不指定，下发为0	是否支持口罩活体
ACTION_LIVENESS_CAPTURE_MODE	28	int	0	实名不指定，下发为1	是否使用新版抓拍算法
ACTION_LIVENESS_QUALITY_THRESH	29	float	0.20	实名不指定，下发为0.15	零动作模式下质量阈值
ACTION_LIVENESS_QUALITY_CACHE	30	float	30	实名不指定，下发为15	零动作模式下图像采集时间
ACTION_LIVENESS_STABLE_THRESH	31	float	0.5	实名不指定，下发为0.5	端上风险检测因子，从该版本内部默认为0.5，该版本前为0.1，越小风险检测越严格。

（3）输出示例

{
    "code":10000,
    "data":{
        "liveness_timeout": 15,
        "motion_types": "0,1",
        "remaining_retry": "10",
        "beauty_intensity": 100,
        "liveness_config":[
				    {
				       "name":  "action_liveness_still_liveness_thresh",
				       "enum":  13,
				       "value": -2.0, // float64
				    },
				    {
				       "name":  "action_liveness_face_similarity_thresh",
				       "enum":  14,
				       "value": 0.35, // float64
				    },
				    {
				       "name":  "action_liveness_face_occupy_ratio",
				       "enum":  24,
				       "value": 1.0, // float64
				    },
				    {
				       "name":  "action_liveness_rotate_flag",
				       "enum":  25,
				       "value": 0, // int 默认下发0
				    }
				]
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	成功