文档中心

VerifyPro接口

最近更新时间：2024.04.19 17:30:17

首次发布时间：2023.04.10 16:53:17

接口简介

身份认证增强版：有源/无源比对。

限制条件

无

请求说明

名称	内容
接口地址	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 放入该参数去请求目标接口。
Content-Type	String	是	application/x-www-form-urlencoded	编码格式

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

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

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

字段名	类型	必选/可选	说明
req_key	string	必选	有源比对填写`cert_pro_src_verify`，无源比对填写`cert_pro_no_src_verify`
byted_token	string	必选	本次核验的唯一token
sdk_data	string	必选（与video_key二选一）	客户端上数据直接透传即可
video_key	string	必选（与sdk_data二选一）	客户端上数据直接透传即可
tos_bucket	string	在video_key不为空时必选	客户端上数据直接透传即可
risk_info	string	必选	客户端上数据直接透传即可
extra	json	在video_key不为空时必选	客户端上数据直接透传即可

输出说明

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

字段名	类型	必选/可选	说明
result	bool	必选	是否核验通过
risk_result	json string	必选	风控接口返回结果的json编码字符串，详细内容见下文
images	json	必选	客户端采集的人脸图
source_comp_details	json	必选	认证结果的细节信息，包括比对的分数和阈值，比对图片的各维度得分，活体算法通过情况，详见下文说明
algorithm_base_resp	json	可选	子错误说明，可以进一步区分错误原因，部分服务异常情况时无法返回。详细见：错误码和计费说明
req_measure_info	bool	可选	计费说明，部分服务异常情况时无法返回。详细见：错误码和计费说明

risk_result说明

字段名	类型	必选/可选	说明	备注
score	int	必选	风控分数	取值见风控分数与返回码
tags	array of string	必选	风险归因列表	取值见风控分数与返回码

images说明

字段名	类型	必选/可选	说明	备注
image_best	string	必选	人脸图的base64
image_env	string	必选	环境图的base64

source_comp_details说明

字段名	类型	必选/可选	说明	备注
score	float64	必选	比对分数
thresholds	json	必选	比对分数阈值
image_face_detail	json string	必选	人脸图质量得分的json编码字符串，具体内容见下文
image_env_detail	json string	必选	环境图质量得分的json编码字符串
alive	bool	必选	活体算法是否通过	活体认证成功为`true`，无论认证是否失败

thresholds说明

字段名	类型	必选/可选	说明	备注
1e-3	float64	必选	0.1%置信度阈值
1e-4	float64	必选	0.01%置信度阈值	此值为判断是否通过的标准
1e-5	float64	必选	0.001%置信度阈值
1e-6	float64	必选	0.0001%置信度阈值

image_face_detail说明
人脸图质量得分

字段名	类型	必选/可选	说明	备注
comprehensive_score	float64	必选	人脸综合得分，用于评估图片中人脸质量的综合分数	`0-100`之间，`50`以上质量较高
face_clarity	float64	必选	人脸清晰度	`0-5`，`3`以上比较清晰
brightness	float64	必选	人脸亮度	`0-1`，小于`0.08`可判定为昏暗
exposure	float64	必选	人脸区域曝光度	通常为`0`，大于`0.6`可判定为有过曝光现象
pose_pitch	float64	必选	俯仰角，代表人脸的上下偏移程度，一般指人在点头时变化的角度
pose_yaw	float64	必选	偏航角，代表人脸左右偏移的程度，一般指人在摇头时变化的角度
pose_roll	float64	必选	旋转角，代表人歪头时变化的角度
mouth_occlude	float64	必选	嘴巴遮挡程度，得分越高遮挡越严重	`0-1`
left_eye_occlude	float64	必选	左眼遮挡程度，得分越高遮挡越严重	`0-1`
right_eye_occlude	float64	必选	右眼遮挡程度，得分越高遮挡越严重	`0-1`
have_cap	float64	必选	是否佩戴帽子，得分越高概率越大	`0-1`

image_env_detail说明
环境图质量得分，各项内容同image_face_detail
（3）输出示例

{
    "code":10000,
    "data":{
        "result": false,
        "risk_result": '{"score":600,"tags":["14004","13001"]}',
        "images": {
            "image_best": "",
            "image_env": ""
        },
         "source_comp_details": {
              "alive": true,
              "image_env_detail":
              '{"comprehensive_score":72.7593973238521,"face_clarity":3.6389399293661118,"exposure":0,"brightness":0.9492753623188406,"pose_pitch":-0.53,"pose_yaw":0.405,"pose_roll":0.388,"mouth_occlude":0.000026744861315819435,"left_eye_occlude":0.000018301761883776635,"right_eye_occlude":0.0026939630042761564,"have_cap":0.00002657439654285554}',
              'image_face_detail':
              '{"comprehensive_score":72.7593973238521,"face_clarity":3.6389399293661118,"exposure":0,"brightness":0.9492753623188406,"pose_pitch":-0.53,"pose_yaw":0.405,"pose_roll":0.388,"mouth_occlude":0.000026744861315819435,"left_eye_occlude":0.000018301761883776635,"right_eye_occlude":0.0026939630042761564,"have_cap":0.00002657439654285554}',
              "score": 87.69,
              "thresholds": {
                  "1e-3": 60,
                  "1e-4": 70,
                  "1e-5": 80,
                  "1e-6": 90
              }
          },
        "algorithm_base_resp": {
              "status_code": 0,
            "status_message": ""
        },
        "req_measure_info": {
              "measure_type": "query_num",
            "value": 1
        }
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

（1）通用错误码
请参考错误码和计费
（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	成功
400	50215	"RPCProcess: xxx"	由于输入的图片、视频、参数等不满足要求，导致认证失败或不通过。此时需要参考上方algorithm_base_resp子错误码。

接口简介

限制条件

请求说明

输出说明

错误码