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>",
      "status": "created",
      "contract_version": 123,
      "share_fields": {},
      "redirect_url": "<string>",
      "verification_url": "<string>",
      "expires_at": "<string>",
      "completed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "cancel_token": "<string>",
      "attempts": [
        {
          "id": "<string>",
          "session_id": "<string>",
          "status": "in_progress",
          "failure_code": "session_expired",
          "risk_score": 0.5,
          "completed_at": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    }
  ],
  "error": {},
  "pagination": {
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kayle.id/llms.txt

Use this file to discover all available pages before exploring further.

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,
completed,
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.

include_attempts
boolean | null

When true, includes the attempts array for each session. When false or omitted, attempts are not returned.

Response

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

data
object[]
required
error
object
required
pagination
object
required