You need to enable JavaScript to run this app.
导航
身份认证
  • 文档首页
    • /
  • 身份认证

Query接口

最近更新时间：2023.07.02 09:30:25

首次发布时间：2023.07.02 09:30:25

我的收藏

接口简介

业务在完成认证后，可以通过服务端调用此接口获取活体认证相关数据。此数据有效期为1小时。由于存储为异步行为，因此会有秒级延迟，若获取不到结果请重试。

限制条件

无

请求说明

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

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

名称类型是否必填示例值描述
X-DateString是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接口名，取值：CertVerifyQuery
Version必选String版本号，取值：2022-08-31

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

字段名类型必选/可选说明备注
req_keystring必选此处请填写cert_verify_query
byted_tokenstring必选通过Token接口获取的byted_token
omit_databool可选默认为false，填写true时Query接口将不会返回图片与视频
omit_image_databool可选默认为false，填写true时Query接口不会返回图片该参数优先级低于omit_data参数
omit_video_databool可选默认为false，填写true时Query接口不会返回视频该参数优先级低于omit_data参数

输出说明

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

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

字段名类型必选/可选说明备注
resultbool必选是否核验通过
imagesjson可选客户端采集的人脸图请求中填写omit_data为true时不返回
videostring可选客户端采集的视频数据请求中填写omit_data为true时不返回
source_comp_detailsjson必选认证的分数和阈值
tos_datajson可选客户在Token接口传入Tos信息时，会返回此字段
verify_algorithm_base_respjson可选子错误说明，可以进一步区分错误原因，部分服务异常情况时无法返回。详细见错误码和计费中的algorithm_base_resp
verify_req_measure_infojson可选计费说明，部分服务异常情况时无法返回。详细见：错误码和计费中的req_measure_info

images说明

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

source_comp_details说明

字段名类型必选/可选说明备注
scorefloat64必选有源比对分数
thresholdsjson必选有源比对分数阈值

thresholds说明

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

tos_data说明

字段名类型必选/可选说明备注
bucketstring必选Tos Bucket
image_env_keystring必选环境图tos key
image_best_keystring必选人脸图tos key
video_keystring必选视频tos key
cert_data_keystring必选认证信息tos key

（3）输出示例

{
    "code":10000,
    "data":{
        "result": false,
        "images": {
            "image_best": "",
            "image_env": ""
        },
        "video": "",
        "source_comp_details": {
            "score": 0.1,
            "thresholds": {
                "1e-3": 0.6,
                "1e-4": 0.7,
                "1e-5": 0.8,
                "1e-6": 0.9
            }
        },
        "tos_data": {
            "bucket": "",
            "image_env_key": "",
            "image_best_key": "",
            "video_key": "",
            "cert_data_key": ""
        },
        "verify_algorithm_base_resp": {
            "status_code": 0,
            "status_message": ""
        },
        "verify_req_measure_info": {
            "measure_type": "query_num",
            "value": 0
        }
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

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

（2）业务错误码

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