> 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 identities

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

Returns a paginated list of verified identities for your organization.
Identities aggregate verification sessions for the same individual.


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

## Authentication

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

## Request

### Query parameters

- `status` (string, optional) — Filter by identity status.
- `q` (string, optional) — Search by external reference.
- `include_archived` (boolean, optional, default: false) — Include archived identities in results.
- `limit` (integer, optional, default: 25) — Maximum number of identities to return.
- `offset` (integer, optional, default: 0) — Number of identities to skip.
- `page[after]` (string, optional) — Cursor for forward pagination. When provided, uses cursor-based pagination instead of offset.
- `page[before]` (string, optional) — Cursor for backward pagination.
- `page[size]` (integer, optional, default: 25) — Page size for cursor pagination.

### 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 identities.

- `data` (list of Identity, required)
- `pagination` (ApiV1IdentitiesGetResponsesContentApplicationJsonSchemaPagination, 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

### Identity

- `id` (string, required)
- `status` (string, required)
- `session_count` (integer, required)
- `is_sandbox` (boolean, required)
- `created_at` (datetime, required)
- `external_ref` (string, optional, nullable)
- `tags` (list of string, optional)
- `last_verified_at` (datetime, optional, nullable)
- `archived_at` (datetime, optional, nullable)
- `identity_type_id` (string, optional, nullable)
- `custom_fields` (map from string to any, optional)

### ApiV1IdentitiesGetResponsesContentApplicationJsonSchemaPagination

- `total` (integer, optional) — Total number of matching identities (offset mode).
- `next_cursor` (string, optional, nullable) — Cursor for the next page (cursor mode).
- `prev_cursor` (string, optional, nullable) — Cursor for the previous page (cursor mode).
- `has_next` (boolean, optional) — Whether there are more results after this page.
- `has_prev` (boolean, optional) — Whether there are results before this page.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "idn_abc123",
      "status": "string",
      "session_count": 1,
      "is_sandbox": true,
      "created_at": "2024-01-15T09:30:00Z",
      "external_ref": "string",
      "tags": [
        "string"
      ],
      "last_verified_at": "2024-01-15T09:30:00Z",
      "archived_at": "2024-01-15T09:30:00Z",
      "identity_type_id": "string",
      "custom_fields": {}
    }
  ],
  "pagination": {
    "total": 1,
    "next_cursor": "string",
    "prev_cursor": "string",
    "has_next": true,
    "has_prev": true
  }
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/identities';
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/identities"

	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/identities")

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/identities")
  .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/identities', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/identities");
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/identities")! 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()
```