纯API接入--身份认证-火山引擎

文档中心

立即注册

导航

纯API接入

最近更新时间：2023.12.12 11:02:51首次发布时间：2023.02.23 11:37:40

接口简介

身份认证（有源认证）纯API接入，不调用活体检测、ocr等算法能力，只上传姓名、身份证号、人脸图信息，直接请求数据源验证是否为本人

限制条件

无

请求说明

名称	内容
接口地址	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	接口名，取值：CertSrcFaceComp
Version	必选	String	版本号，取值：2022-08-31

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

字段名	类型	必选/可选	说明	备注
req_key	string	必选	此处请填写`cert_src_face_comp`
idcard_name	string	在有源比对时必选	身份证姓名
idcard_no	string	在有源比对时必选	身份证号
image	string	必选	人脸图	人脸图Base64，不带mime前缀

输出说明

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

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

字段名	类型	必选/可选	说明
byted_token	string	必选	本次人脸核身的唯一token
result	bool	必选	是否核验通过
source_comp_details	json	必选	认证的分数和阈值
verify_algorithm_base_resp	json	可选	子错误说明，可以进一步区分错误原因，部分服务异常情况时无法返回。详细见错误码和计费中的algorithm_base_resp
verify_req_measure_info	bool	可选	计费说明，部分服务异常情况时无法返回。详细见：错误码和计费中的req_measure_info

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":{
		    "byted_token": "",
        "result": false,
        "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	错误码	错误消息	描述
200	10000	"Success"	成功