POST https://art-api.yuyuflow.com/?Action=CreateVisualValidateSession&Version=2024-01-01

拉起端上 H5 真人认证页链接。

终端客户使用H5Link完成真人认证，点击“完成”按钮后，将打开 CallbackURL 链接，您可通过解析 CallbackURL 地址后拼接的 resultCode 参数，获取真人认证结果。

终端客户通过真人认证（ resultCode 为 10000 ）后，您可使用 API 返回的 BytedToken 查询该终端客户对应的 Asset Group ID。具体使用方式请参考拉起端上 H5 活体认证页。

鉴权说明

本接口仅支持 Access Key（AK/SK）鉴权，详情参考 获取 API 访问密钥（AK/SK）。

请求参数​

请求体​

CallbackURL string 必选

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

ProjectName string

资源所属的项目名称，默认值为 default。（大小写敏感）

若资源不在默认项目中，需填写正确的项目名称，获取项目名称，请查看 文档。

响应参数​

BytedToken string

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

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

H5Link string

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

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

CallbackURL string

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

说明

终端客户使用H5Link完成真人认证，点击“完成”按钮后，将打开 CallbackURL 链接，您可解析CallbackURL 链接后拼接的相关参数获取认证结果。

  • 拼接示例：

    <CallbackURL>?bytedToken=&resultCode=10000&algorithmBaseRespCode=0&reqMeasureInfoValue=1&verify_type=real_time

  • 详细后缀参数：

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

    • resultCode：

      • 当 resultCode 为 10000 时，检测成功 。

      • 更多错误码信息请参考真人认证相关错误码文档。

    • algorithmBaseRespCode：服务端子错误码。建议resultCode为服务端错误码时，再检查该字段对应的错误类型。具体请参考真人认证相关错误码文档。

    • reqMeasureInfoValue：本次操作是否计费，取值为0或1。0为不计费，1为计费。 当前真人认证相关服务限时免费 。

    • verify_type：认证类型，当前为固定值 real_time。

请求示例​

text
POST /?Action=CreateVisualValidateSession&Version=2024-01-01 HTTP/1.1
Host: art-api.yuyuflow.com
Content-Type: application/json
X-Date: 20260328T000000Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f

{
    "CallbackURL": "https://www.example.com/callback"
  }
}

响应示例​

JSON
{
    "BytedToken": "********22041234D89A4DDA08**************",
    "H5Link": "https://ark.volcengine.com/region:cn-beijing/mobile/livenees-face-manage/authorization?pl=******************-MHtzpZgfMzdQBr3o8weNgvI9Y9u5sak851FmXyXDqtR5UbeNikIKNi_fc8M7FhnT_zYm1XH0MqCdXPOySaaD23WYChutGBWrtTyB5Jo50j5LBNKqdLXi8WrxmiaW3H8cgP4eT2lfUgTjSAvcMaqLJLFcmYLVtGDea_lE__qd466BHHunNvT4zp9Az2eIUM47hyysass0c0twQ6Ld-Bxo0gp9Sac6v1whEDoaUZvcTYns6F129NjhFBNb-Twek0OnM4klo-G1sW2Uab6dGsM0g1Y4PN85sCYsb_3HCCIqsnkIjMxuK31waX-K7Y6R7gCyT3NuqSA7b1UJdsvGXWUrdlq4mUeDcwsyfKCZ9xf-Yj7qhCUyaUAG28jZPQH34oIc-T82_oxRKo3ZRr6BMWoUc18NSIUtyK48VLdFTr5PsjEFwdeuaTzA9PUhlNwC10_jb6SRhaocbI-Oke-BsiVTmqjVmlrK9q0BkmjGwLvjKSxU4_oMjoDWyy9h1nFabZOtHR9kyw6fe7Lf5bV9LvVGN1TXwQZ-o6EZR3K9ajMYgvao_l7w2gSttKCwK6k4eScTeCBMb3JR73xwEV0BMMSVF93ifdbEZS1WvPCA0F7wc_fxk97Q1JA_qLChsUKoJJ_ShN2Y4hqKCPElY9fmOYWzl1XOdx8E9nzFvN0sPd6O8LkrWMnFjPe8R3aHRMzvF4csL3nCQHoY5bWX2oOnPoYX7OHbn2tHT_KIoKQkFdQ************************&uid=2cff9805-****-****-****-c7f69dcf311d",
    "CallbackURL": "https://www.example.com/callback"
  }