v1

latestOpenAPI 3.0.42026-07-2419101123.9 KB

Sessions

List Sessions

List Sessions created for a specific Verification Profile

get/api/v1/verification-profiles/{verificationProfileId}/sessions

Path parameters

verificationProfileIdstring uuid required

Query parameters

OrderBy'Created' | 'Updated' | 'State'

The field by which sessions should be ordered

OrderDirection'Ascending' | 'Descending'

PageSizeinteger

Example:50

The number of items to return per page -- must be between 1 and 50

Pageinteger

Example:1

The page number to return -- starts at 1

Response

totalinteger required

The total number of sessions tied to your account

moreboolean required

Whether there are additional pages of sessions to retrieve

Example response

{
  "sessions": [
    {
      "id": "678c1ff6-2178-49e7-81d2-548afb6f85ec",
      "created": 1722526411,
      "updated": 1722526722
    }
  ],
  "total": 101,
  "more": true
}