Skip to main content

Create Verification Session

POST /api/volc-user/visual-validate-sessions

Create an H5 verification link with the result displayed by the platform. Successful verification creates a LivenessFace group; use Query Verification Session to obtain its groupId.

Authentication

Use a logged-in session Cookie or the Authorization: <access_token> header. Obtain the access token through Generate Access Token. It is different from the sk- key used for model requests.

Request Parameters​

NameTypeRequiredDescription
namestringRequiredAsset group name after verification; must not be blank after trimming
descriptionstringOptionalAsset group description after verification

Request Example​

POST /api/volc-user/visual-validate-sessions
Authorization: <access_token>
Content-Type: application/json

{
"name": "Performer Asset Group",
"description": "For authorized video generation"
}

Response Fields (200)​

NameTypeDescription
successbooleanBusiness success flag; check it even for HTTP 200
messagestringMessage; empty on success
dataobjectResponse data on success
data.sessionIdstringPlatform session ID used to query the result
data.statusstringPending, Processing, Succeeded, Failed, or Expired; see Integration Guide
data.h5LinkstringReturned only while Pending and unexpired; the person being verified must open it
data.expiresAtintegerLink expiry time in Unix seconds; sessions currently expire 120 seconds after creation
data.groupIdstringPlatform asset group ID after success; omitted when absent or, for queries, when the group has been deleted
data.resultCodestringH5 verification result code, if present; 10000 indicates verification success
data.errorCodestringError code, if present
data.errorMessagestringError message, if present
data.createTimeintegerCreation time in Unix seconds
data.updateTimeintegerUpdate time in Unix seconds

Response Example​

{
"success": true,
"message": "",
"data": {
"sessionId": "vvs-example",
"status": "Pending",
"expiresAt": 1792022520,
"createTime": 1792022400,
"updateTime": 1792022400,
"h5Link": "https://example.com/visual-validate?token=example"
}
}

Send JSON fields at the top level without a body wrapper. This mode does not accept a customer callback URL; use Custom Callback Mode to return to your application after verification.