v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Onboarding

List Guided identity verification sessions

Returns a paginated list of Guided identity verification sessions on your account. Results are sorted by createdAt descending (newest first). Filter by applicationId or associatedPersonId to narrow results. When a person appears on multiple applications, their session is returned once per application — the rows share the same id but differ in applicationId.

get/applications/identity-verification-sessions

Query parameters

limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100
applicationIdstring uuid

Filter sessions by application.

associatedPersonIdstring uuid

Filter sessions by associated person.

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "5f8a2c14-3e6b-4d9f-a1b2-c3d4e5f60789",
      "applicationId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "associatedPersonId": "d4c3b2a1-5678-4e9a-bcde-f01234567890",
      "correlationId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "actionUrl": "https://verify.example.com/session/abc123",
      "status": "completed",
      "result": "approved",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}