面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/h5-create-visual-validate-session-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

拉起真人认证 H5

POST https://ark.cn-beijing.volcengineapi.com/?Action=CreateVisualValidateSession&Version=2024-01-01

拉起端上 H5 真人认证页链接。
终端客户使用 H5Link 完成真人认证,点击"完成"按钮后,将打开 CallbackURL 链接,您可通过解析 CallbackURL 地址后拼接的 resultCode 参数,获取真人认证结果。
终端客户通过真人认证(resultCode 为 10000)后,您可使用 API 返回的 BytedToken 查询该终端客户对应的 Asset Group ID。具体使用方式请参考 拉起端上 H5 活体认证页。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

CallbackURL string 必选  |  回调 URL

用于认证结束后跳转的可访问 URL

ProjectName string 默认值 default  |  所属项目

资源所属的项目名称(大小写敏感)。若资源不在默认项目中,需填写正确的项目名称。

响应参数#

BytedToken string  |  认证凭证

本次认证的唯一凭证标识,用来在 GetVisualValidateResult 获取本次创建的 Group ID。

注意:byted_token 有效期为 30 分钟,请及时使用(仅支持认证一次,禁止重复认证)。

CallbackURL string  |  回调 URL

用于认证结束后跳转的公网可访问 URL

H5Link string  |  H5 认证链接

链接在使用后失效,再次检测需重新调用 CreateVisualValidateSession 生成链接。

注意:可通过 H5Link 链接后缀的 lng 字段指定页面语言。目前支持简体中文 zh、英文 en 和繁体 zh-Hant,默认值为 zh。