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

# Search identities

POST https://api.withverifa.com/api/v1/identities/search
Content-Type: application/json

Search for identities by field-match filters. PII fields (name, DOB,
document number, SSN) are matched via HMAC hashes — the plaintext
values provided in the request are hashed and compared against stored
hashes, never stored themselves.

For name+DOB search, all three fields (`first_name`, `last_name`,
`date_of_birth`) must be provided together.

Non-PII filters (`external_ref`, `status`, `country`) use direct
matching.


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

## Authentication

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

## Request

### 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`

### Body (application/json)

This endpoint expects a SearchIdentitiesRequest.

- `external_ref` (string, optional) — Exact match on external reference.
- `status` (string, optional) — Filter by identity status.
- `first_name` (string, optional) — First name (used with last_name + date_of_birth for hash match).
- `last_name` (string, optional) — Last name (used with first_name + date_of_birth for hash match).
- `date_of_birth` (string, optional) — Date of birth as YYYY-MM-DD (used with first_name + last_name).
- `document_number` (string, optional) — Document number for hash match.
- `ssn` (string, optional) — SSN for hash match.
- `country` (string, optional) — ISO 3166-1 alpha-2 country code.
- `email` (string, optional) — Email address for hash match.
- `phone` (string, optional) — Phone number for hash match.
- `city` (string, optional) — City for hash match.
- `state` (string, optional) — State/province for hash match.
- `zip_code` (string, optional) — Zip/postal code for hash match.
- `limit` (integer, optional, default: 25)
- `offset` (integer, optional, default: 0)

## Response

### 200

Search results.

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

### 422 Unprocessable Entity Error

Validation error (e.g. partial name+DOB).

- `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)

### ApiV1IdentitiesSearchPostResponsesContentApplicationJsonSchemaPagination

- `total` (integer, required)

## Examples

**Request**

```json
{}
```

**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
  }
}
```

**SDK Code**

```python
import requests

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

payload = {}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/identities/search';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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.post("https://api.withverifa.com/api/v1/identities/search")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.withverifa.com/api/v1/identities/search', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/identities/search");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/identities/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```