Skip to main content
GET
/
v1
/
sessions
List all sessions
curl --request GET \
  --url http://127.0.0.1:8787/v1/sessions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "nfc_tries_used": 1,
      "liveness_tries_used": 1,
      "contract_version": 123,
      "share_fields": {},
      "redirect_url": "<string>",
      "webhook_endpoint_id": "<string>",
      "verification_url": "<string>",
      "expires_at": "<string>",
      "completed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "cancel_token": "<string>"
    }
  ],
  "error": null,
  "pagination": {
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Filter sessions by status.

Available options:
created,
in_progress,
succeeded,
failed,
expired,
cancelled
created_from
string<date-time>

Return sessions created at or after this ISO 8601 timestamp.

created_to
string<date-time>

Return sessions created at or before this ISO 8601 timestamp.

limit
integer

Maximum number of sessions to return. Defaults to 10 if not specified.

Required range: 1 <= x <= 100
starting_after
string

Cursor of the last item from the previous page. When provided, the next page of results will be returned.

Pattern: ^vs_[A-Za-z0-9]{64}$

Response

Successful operation. Returns a list of verification sessions for the organization.

data
object[]
required
error
null
required
pagination
object
required