TokenLab
取得 API Key
文件API 參考整合

視頻與素材

取得視覺驗證結果

取得視覺驗證產生的真人素材群組。

POST
/api/v3

H5 視覺驗證流程結束後輪詢此 Action。成功結果會回傳已驗證人員對應的 TokenLab 素材群組 ID。

查詢時須使用建立會話的同一組織、使用者，以及相同且區分大小寫的 ProjectName。

端點與驗證

POST https://api.tokenlab.sh/api/v3?Action=GetVisualValidateResult&Version=2024-01-01
Authorization: Bearer <TOKENLAB_API_KEY>
Content-Type: application/json

傳送 建立視覺驗證會話 回傳的 BytedToken。若建立時設定了 ProjectName，此處必須傳送相同且區分大小寫的值；否則可省略或使用 default。

瀏覽器回呼後，結果可能不會立即就緒。請重試相同請求，直到回傳 Result.GroupId，或有效期 30 分鐘的 BytedToken 過期。使用相同 token 重複成功請求會回傳相同的對應 GroupId。

建立 liveness_face 素材時，請將回傳的 GroupId 作為 group_id。

請求範例

curl 'https://api.tokenlab.sh/api/v3?Action=GetVisualValidateResult&Version=2024-01-01' \
  -H "Authorization: Bearer $TOKENLAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"BytedToken":"ZXhhbXBsZS10b2tlbg","ProjectName":"default"}'

回應範例

{
  "ResponseMetadata": {
    "RequestId": "req_def456",
    "Action": "GetVisualValidateResult",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "GroupId": "group-20260720123456-real1"
  }
}

錯誤使用 ResponseMetadata.Error.Code 與 ResponseMetadata.Error.Message。成功回應包含 ResponseMetadata 與 Result，不使用 TokenLab 其他 /v1 API 的回應結構。

curl -X POST "https://example.com/api/v3" \  -H "Content-Type: application/json" \  -d '{    "CallbackURL": "http://example.com"  }'
{  "id": "string"}

授權

BearerAuth
AuthorizationBearer <token>

API Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。

位置: header

查詢參數

Action?string

可選值

  • "CreateContentsGenerationsTasks"
  • "GetContentsGenerationsTask"
  • "ListContentsGenerationsTasks"
  • "DeleteContentsGenerationsTasks"
  • "CreateVisualValidateSession"
  • "GetVisualValidateResult"
  • "CreateAssetGroup"
  • "ListAssetGroups"
  • "GetAssetGroup"
  • "UpdateAssetGroup"
  • "DeleteAssetGroup"
  • "CreateAsset"
  • "ListAssets"
  • "GetAsset"
  • "UpdateAsset"
  • "DeleteAsset"
Version?string
預設值"2024-01-01"

請求標頭

X-TokenLab-Delivery-Policy?string

單次請求傳遞策略。會覆寫 API key 與 Workspace 的預設值。系統會自動優先嘗試 TokenLab Verified，並可能在輸出、請求接受或建立持久性資源前切換至 Official 模式一次。

可選值

  • "auto"
  • "verified"
  • "official"

請求主體

application/json

回應

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

建立視覺驗證會話

上一頁

素材 Action（火山相容）

下一頁