> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# List sessions

GET https://api.withverifa.com/api/v1/sessions

Returns a paginated list of sessions for your organization.

Reference: https://docs.withverifa.com/api-reference/sessions/list-sessions

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Query parameters

- `status` (enum, optional) — Filter by session status.
  - Allowed values: `pending`, `capturing`, `processing`, `sandbox_pending`, `completed`, `expired`, `failed`, `awaiting_external`, `under_review`
- `q` (string, optional) — Search by session ID or external reference.
- `limit` (integer, optional, default: 50) — Maximum number of sessions to return.
- `offset` (integer, optional, default: 0) — Number of sessions to skip.

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.
- `Key-Inflection` (enum, optional, default: snake) — Response key casing. Defaults to `snake`.
  - Allowed values: `camel`, `kebab`, `snake`

## Response

### 200

A list of sessions.

- `data` (list of SessionSummary, required)
- `pagination` (ApiV1SessionsGetResponsesContentApplicationJsonSchemaPagination, required)

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 429 Too Many Requests Error

Too many requests.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Types

### SessionSummary

- `id` (string, required)
- `status` (enum, required)
  - Allowed values: `pending`, `capturing`, `processing`, `sandbox_pending`, `completed`, `expired`, `failed`, `awaiting_external`, `under_review`
- `created_at` (datetime, required)
- `result_status` (string, optional, nullable) — Aggregate result status from session_results (e.g. passed, failed).
- `result_rejection_reason` (string, optional, nullable) — Rejection reason from session_results, if any.
- `result_rejection_reason_code` (enum, optional) — Structured reason a verification was rejected. Complements the free-text `rejection_reason`. Stable enum — clients can pivot UI and metrics off this without parsing prose.
  - Allowed values: `document_unreadable`, `document_expired`, `document_unsupported`, `document_authenticity`, `face_mismatch`, `liveness_failed`, `age_under_threshold`, `aml_hit`, `duplicate_identity`, `blocklist_match`, `geo_blocked`, `identity_blocked`, `poa_failed`, `poa_review`, `nfc_failed`, `consistency_failed`, `manual_reject`, `other`
- `risk_level` (string, optional, nullable) — Most recent risk level from fraud signals.
- `external_ref` (string, optional, nullable)
- `is_sandbox` (boolean, optional)
- `country` (string, optional, nullable)
- `tags` (list of string, optional)
- `workflow_id` (string, optional, nullable)
- `retention_status` (string, optional, nullable) — Data retention status (active, sensitive_redacted, redacted).
- `updated_at` (datetime, optional)

### ApiV1SessionsGetResponsesContentApplicationJsonSchemaPagination

- `total` (integer, required) — Total number of matching items.
- `limit` (integer, required)
- `offset` (integer, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "ses_abc123",
      "status": "pending",
      "created_at": "2024-01-15T09:30:00Z",
      "result_status": "string",
      "result_rejection_reason": "string",
      "result_rejection_reason_code": "document_unreadable",
      "risk_level": "string",
      "external_ref": "string",
      "is_sandbox": true,
      "country": "string",
      "tags": [
        "string"
      ],
      "workflow_id": "string",
      "retention_status": "string",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/sessions"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/sessions';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.withverifa.com/api/v1/sessions")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.withverifa.com/api/v1/sessions', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/sessions");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/sessions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```