You need to enable JavaScript to run this app.
导航
Verify接口
最近更新时间:2025.04.28 14:43:10首次发布时间: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

接口名,取值:CertVerify

Version

必选

String

版本号,取值:2022-08-31

(3)Body请求参数
业务请求参数

字段名

类型

必选/可选

说明

备注

req_key

string

必选

有源认证请填写cert_src_verify,无源认证请填写cert_no_src_verify

byted_token

string

必选

通过Token接口获取的byted_token

video_data

string

可选

video_data和video_url二选一,用户上传的视频数据

二进制sdk_data转base64后的数据

video_url

string

可选

video_data和video_url二选一,用户上传的视频数据

在国内公网可直接下载的视频链接

extra

string

必选

额外参数,Json String

目前需在extra里指定活体类型,目前支持字段"video_type",可选值"motion"(动作活体), "still"(静默活体)

extra说明

extra=json.dumps({"video_type": "motion"})
* 字段说明:
video_type: string,可选值"motion"(动作活体), "still"(静默活体)

输出说明

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

字段名

类型

必选/可选

说明

备注

result

bool

必选

是否核验通过

images

json

必选

客户端采集的人脸图

source_comp_details

json

必选

认证的分数和阈值

images说明

字段名

类型

必选/可选

说明

备注

image_best

string

必选

人脸图的base64

image_env

string

必选

环境图的base64

source_comp_details说明

字段名

类型

必选/可选

说明

备注

score

float64

必选

有源比对分数

thresholds

json

必选

有源比对分数阈值

thresholds说明

字段名

类型

必选/可选

说明

备注

1e-3

float64

必选

0.1%置信度阈值

1e-4

float64

必选

0.01%置信度阈值

此值为判断是否通过的标准

1e-5

float64

必选

0.001%置信度阈值

1e-6

float64

必选

0.0001%置信度阈值

(3)输出示例

{
    "code":10000,
    "data":{
        "result": false,
        "images": {
            "image_best": "",
            "image_env": ""
        },
        "source_comp_details": {
            "score": 0.1,
            "thresholds": {
                "1e-3": 0.6,
                "1e-4": 0.7,
                "1e-5": 0.8,
                "1e-6": 0.9
            }
        }
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

(1)通用错误码
请参考通用返回字段及错误码
(2)业务错误码

HttpCode

错误码

错误消息

描述

200

10000

"Success"

成功