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

H5Token配置

最近更新时间：2024.02.01 11:26:23

首次发布时间：2024.01.26 16:33:32

我的收藏
接口简介

在H5增强版中，如果需要同时跳过OCR上传图片识别、输入身份证号和姓名 这两个步骤，直接进行人脸认证流程。则需要将临时生成的H5configId和用户认证资料传入该接口，得到一个bytedtoken，并拼接到认证服务H5的URL中。该bytedtoken将作为本次认证的唯一凭证标识。

特殊说明

生成的byted_token会在生成的一段时间后失效，有效期为60分钟，请及时使用(仅支持认证一次，禁止重复认证)。

请求说明

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

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

字段名类型必选/可选说明备注
req_keystring必选此处请填写cert_h5_token
h5_config_idstring必选H5临时configId，生成方式请参照CertH5ConfigInit
sts_tokenstring必选通过STS接口获取的临时token
idcard_namestring在有源比对时必选身份证姓名
idcard_nostring在有源比对时必选身份证号
ref_imagestring在无源比对时必选输入图片的base64数组，在无源比对时需要传入1张用户的基准图，有源比对无需传入

（4）请求Body输入示例

{
    "req_key":"cert_h5_token",
    "h5_config_id":"d6f04739-644e-4ff0-axxe-0299a852a2cc",
    "sts_token":"nCgdqdEROend3.Chxxx",
    "idcard_name":"xxxx",
    "idcard_no":"xxx"
	  //"ref_image":"/9xxx"
}
输出说明

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

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

字段名类型必选/可选说明备注
algorithm_base_respjson必选子错误码说明
byted_tokenstring必选本次人脸核身的唯一token

（3）输出示例

{
    "code":10000,
    "data":{
        "algorithm_base_resp":{
            "status_code":0,
            "status_message":"SUCCESS"
        },
        "auth_result":{ //auth_result无须关注
            "beauty_intensity":"",
            "liveness_config":null,
            "liveness_timeout":"",
            "liveness_type":"",
            "motion_types":"",
            "remaining_retry":""
        },
        "binary_data_base64":[//binary_data_base64无须关注

        ],
        "byted_token":"202401312053219F6F6C25DD5C087C5EE9",
        "client_config":"" //client_config 无须关注此字段
    },
    "message":"Success",
    "request_id":"202401312053219F6F6C25DD5C087C5EE9",
    "status":10000,
    "time_elapsed":"102.549292ms"
}
错误码

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

（2）业务错误码

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