Skip to main content

Query Verification Session

GET /api/volc-user/visual-validate-sessions/{sessionId}

Query a single session created by the current user. Both creation modes use this endpoint. The platform groupId is returned after success while the group remains visible.

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
sessionIdstringRequiredPath parameter: sessionId from standard creation or platformSessionId from custom callback creation

Request Example​

GET /api/volc-user/visual-validate-sessions/vvs-example
Authorization: <access_token>

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": "Succeeded",
"expiresAt": 1792022520,
"createTime": 1792022400,
"updateTime": 1792022430,
"groupId": "group-example",
"resultCode": "10000"
}
}

A session still Pending after its expiry is marked Expired when queried. Create a new session to restart verification. A successful session does not imply that usable assets exist in the group; create assets and query them until Active.