XRToken API 文档

发起真人活体认证会话

API 配置
保存后下方「Try It」面板会自动携带此 API Key 发送真实请求。
Base: api.xrtoken.net

为终端用户发起一次 BytePlus/Volcengine Ark 真人活体认证。返回 H5 链接、轮询用的 BytedToken、回调地址,以及一个预渲染的 QR 码(PNG base64 data URL),集成方可以直接嵌入 <img> 展示给终端用户扫码完成活体。

调用前账户需满足:已开通可信创作者(trusted_creator)+ 已完成企业认证。调用方用户需先通过 POST /v1/face-consent 完成人脸信息处理规则的同意。

POST
/v1/asset-groups/validate-session

Authorization

BearerAuth
AuthorizationBearer <token>

API 密钥认证(OpenAI 格式)。在 Authorization 请求头中传入:

Authorization: Bearer tr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X post "https://api.xrtoken.net/v1/asset-groups/validate-session" \  -H "Content-Type: application/json" \  -d '{}'
{
  "ResponseMetadata": {},
  "Result": {
    "H5Link": "https://h5-v2.kych5.com?accessKeyId=AKTP...&bytedToken=...&lng=zh",
    "BytedToken": "string",
    "CallbackURL": "http://example.com",
    "QRCodeDataURL": "data:image/png;base64,iVBORw0KGgoAAAANS..."
  }
}
{
  "error": "invalid or missing API key",
  "type": "auth_error"
}
{
  "error": "string",
  "type": "invalid_request_error"
}
{
  "error": "upstream provider error",
  "type": "server_error"
}