Skip to main content

List Verification Sessions

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

List the current user's sessions from both creation modes, ordered by record ID descending.

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
pageNumberintegerOptionalPage number, starting at 1; defaults to 1
pageSizeintegerOptionalPage size; defaults to 20 and resets to 20 when below 1 or above 100
statusstringOptionalFilter by Pending, Processing, Succeeded, Failed, or Expired; omit for all sessions

Request Example​

GET /api/volc-user/visual-validate-sessions?pageNumber=1&pageSize=20&status=Succeeded
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.totalCountintegerTotal number of records
data.pageNumberintegerCurrent page number
data.pageSizeintegerPage size
data.itemsarray<object>Records on the current page
data.items[].sessionIdstringPlatform session ID used to query the result
data.items[].statusstringPending, Processing, Succeeded, Failed, or Expired; see Integration Guide
data.items[].h5LinkstringReturned only while Pending and unexpired; the person being verified must open it
data.items[].expiresAtintegerLink expiry time in Unix seconds; sessions currently expire 120 seconds after creation
data.items[].groupIdstringPlatform asset group ID after success; omitted when absent or, for queries, when the group has been deleted
data.items[].resultCodestringH5 verification result code, if present; 10000 indicates verification success
data.items[].errorCodestringError code, if present
data.items[].errorMessagestringError message, if present
data.items[].createTimeintegerCreation time in Unix seconds
data.items[].updateTimeintegerUpdate time in Unix seconds

Response Example​

{
"success": true,
"message": "",
"data": {
"totalCount": 1,
"pageNumber": 1,
"pageSize": 20,
"items": [
{
"sessionId": "vvs-example",
"status": "Succeeded",
"expiresAt": 1792022520,
"createTime": 1792022400,
"updateTime": 1792022430,
"groupId": "group-example",
"resultCode": "10000"
}
]
}
}

The session ID field is always sessionId in this list. Deleted groups are no longer returned through groupId, while verification history is retained.