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

# Create a check

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

Creates an on-demand screening check or risk report against the specified check type.

**AML checks** (`sanction`, `pep`, `adverse_media`, `warning`) screen a person against
global watchlists including OFAC/SDN, EU/UN/UK sanctions, and PEP databases. Requires
`name_first` and `name_last`; optionally include `birthdate` for higher-accuracy matching.
PEP checks return a `pep_risk_tier` (critical/high/medium/low) and `pep_recommended_action`.

**Risk checks** (`email_risk`, `phone_risk`, `ip_risk`) run basic fraud signal analysis
using internal providers.

**Enhanced checks** (`email_risk_enhanced`, `phone_risk_enhanced`, `address_validation`, `ssn_verification`)
use premium third-party providers for deeper analysis. These require
the corresponding feature to be enabled on your plan.

Use `POST /checks/full` to run multiple check types in a single request.


Reference: https://docs.withverifa.com/api-reference/checks/create-check

## 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.
- `Idempotency-Key` (string, optional) — Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns `422`.

### Body (application/json)

This endpoint expects an object.

- `check_type` (enum, required) — The type of check to run. **AML types** require `name_first`/`name_last`. **Risk types** require the relevant input field (email, phone, or ip_address). **Enhanced types** require plan-level feature enablement.
  - Allowed values: `sanction`, `pep`, `adverse_media`, `warning`, `email_risk`, `phone_risk`, `ip_risk`, `email_risk_enhanced`, `phone_risk_enhanced`, `address_validation`, `ssn_verification`
- `external_ref` (string, required) — Your external reference for the subject. Used to link checks to an identity.
- `name_first` (string, optional) — Subject's first name. Required for AML check types.
- `name_last` (string, optional) — Subject's last name. Required for AML check types.
- `birthdate` (date, optional) — Subject's date of birth (ISO 8601). Improves AML match accuracy.
- `country_code` (string, optional) — Two-letter country code (ISO 3166-1 alpha-2).
- `email` (string, optional) — Required for `email_risk` and `email_risk_enhanced` checks.
- `phone` (string, optional) — Required for `phone_risk` and `phone_risk_enhanced` checks. E.164 format.
- `ip_address` (string, optional) — Required for `ip_risk` checks. IPv4 or IPv6.
- `address` (ApiV1ChecksPostRequestBodyContentApplicationJsonSchemaAddress, optional) — Required for `address_validation` checks.
- `ssn` (string, optional) — Social Security Number. Required for `ssn_verification` checks. Accepts dashed (123-45-6789) or undashed format. US only. Stored encrypted; never returned in responses.
- `enable_monitoring` (boolean, optional, default: false) — Enable continuous monitoring (AML check types only, requires Professional+ plan).

## Response

### 201

Check created.

- `id` (string, optional)
- `check_type` (enum, optional) — The type of check. Categories: - **AML**: `sanction`, `pep`, `adverse_media`, `warning` — screen against global sanctions, PEP, and adverse-media watchlists - **Risk**: `email_risk`, `phone_risk`, `ip_risk` — lightweight risk scoring - **Enhanced**: `email_risk_enhanced`, `phone_risk_enhanced`, `address_validation`, `ssn_verification` — deep provider-backed analysis
  - Allowed values: `sanction`, `pep`, `adverse_media`, `warning`, `email_risk`, `phone_risk`, `ip_risk`, `email_risk_enhanced`, `phone_risk_enhanced`, `address_validation`, `ssn_verification`
- `status` (enum, optional) — Check status. `pending` = still processing, `clear` = no matches/low risk, `hit` = matches found or high risk, `error` = provider failure.
  - Allowed values: `pending`, `clear`, `hit`, `error`
- `has_match` (boolean, optional) — Whether the check found any matches or flagged risk.
- `hit_count` (integer, optional) — Number of screening hits found (AML checks) or 0/1 for risk checks.
- `provider` (string, optional, nullable) — Sanitized provider category for the check (e.g., `aml_screening`, `email_risk`, `phone_risk`, `address_verification`). Raw vendor identifiers are scrubbed at the API boundary — the underlying vendor name is never exposed to API clients.
- `session_id` (string, optional, nullable) — Associated session ID, if the check was triggered as part of a verification session.
- `identity_id` (string, optional, nullable) — Associated identity ID, if the check is linked to a known identity.
- `external_ref` (string, optional, nullable) — Your external reference for the subject.
- `monitoring_enabled` (boolean, optional) — Whether ongoing monitoring is enabled for this check (AML only).
- `is_sandbox` (boolean, optional) — Whether this check was created in sandbox mode (uses test data).
- `tags` (list of string, optional) — Custom tags attached to this check.
- `batch_id` (string, optional, nullable) — Batch ID if this check was created via the bulk endpoint.
- `pep_risk_tier` (enum, optional) — PEP risk classification tier. Only present for `pep` check type.
  - Allowed values: `tier_1`, `tier_2`, `tier_3`, `tier_4`
- `pep_recommended_action` (string, optional, nullable) — Recommended action based on PEP risk tier. Only present for `pep` check type.
- `redacted_at` (datetime, optional, nullable) — When check data was redacted (GDPR). Only present if redacted.
- `last_checked_at` (datetime, optional)
- `created_at` (datetime, optional)
- `expires_at` (datetime, optional)
- `result` (CheckResult, optional, nullable) — Provider result data. Structure varies by check type: * **AML**: `{match_count, highest_score, ...}` * **Risk**: `{risk_score, risk_level, deliverable, fraud_score, ...}` * **Enhanced**: Provider-specific detailed analysis object
- `hits` (list of ScreeningHit, optional) — Screening hits (matches). Only included when fetching check detail.

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

Request validation failed.

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

## Types

### ApiV1ChecksPostRequestBodyContentApplicationJsonSchemaAddress

Required for `address_validation` checks.

- `street` (string, optional) — Street address (required).
- `city` (string, optional)
- `state` (string, optional)
- `zip_code` (string, optional)
- `country` (string, optional) — Two-letter country code (required).

### CheckResult

Provider result data. Structure varies by check type: * **AML**: `{match_count, highest_score, ...}` * **Risk**: `{risk_score, risk_level, deliverable, fraud_score, ...}` * **Enhanced**: Provider-specific detailed analysis object

### ScreeningHit

A screening match found during an AML check. Includes similarity scoring, source information, and type-specific enrichment (e.g., `pep_details`, `sanction_details`, `adverse_media_details`).

- `id` (string, required)
- `created_at` (datetime, required)
- `matched_name` (string, optional, nullable) — The name of the matched entity from the watchlist.
- `name_similarity` (double, optional) — Name similarity score between 0.0 and 1.0.
- `dob_match` (boolean, optional, nullable) — Whether the date of birth matched, if provided.
- `combined_score` (double, optional) — Combined match score factoring name, DOB, and other signals.
- `hit_source` (string, optional, nullable) — Source list or database that produced this hit (e.g., OFAC, UN, EU).
- `hit_type` (string, optional, nullable) — Type of match (e.g., sanction, pep, adverse_media, warning).
- `provider_ref` (string, optional, nullable) — Provider's unique reference for this entity.
- `deceased` (boolean, optional, nullable) — Whether the matched entity is deceased (if known).
- `is_false_positive` (boolean, optional) — Whether this hit has been dismissed as a false positive.
- `pep_details` (ScreeningHitPepDetails, optional, nullable) — PEP-specific enrichment. Only present for PEP hits.
- `sanction_details` (ScreeningHitSanctionDetails, optional, nullable) — Sanction-specific enrichment. Only present for sanction hits.
- `adverse_media_details` (ScreeningHitAdverseMediaDetails, optional, nullable) — Adverse media enrichment. Only present for adverse_media hits.

### ScreeningHitPepDetails

PEP-specific enrichment. Only present for PEP hits.

- `sources` (list of string, optional)
- `positions` (list of ScreeningHitPepDetailsPositionsItems, optional)
- `associates` (list of ScreeningHitPepDetailsAssociatesItems, optional)
- `pep_class` (string, optional, nullable)

### ScreeningHitSanctionDetails

Sanction-specific enrichment. Only present for sanction hits.

- `sources` (list of string, optional)
- `list_name` (string, optional, nullable)
- `program` (string, optional, nullable)
- `listed_on` (string, optional, nullable)

### ScreeningHitAdverseMediaDetails

Adverse media enrichment. Only present for adverse_media hits.

- `sources` (list of ScreeningHitAdverseMediaDetailsSourcesItems, optional)

### ScreeningHitPepDetailsPositionsItems

- `title` (string, optional)
- `country` (string, optional, nullable)
- `from` (string, optional, nullable)
- `to` (string, optional, nullable)

### ScreeningHitPepDetailsAssociatesItems

- `name` (string, optional)
- `relationship` (string, optional, nullable)

### ScreeningHitAdverseMediaDetailsSourcesItems

- `name` (string, optional)
- `url` (string, optional, nullable)
- `date` (string, optional, nullable)

## Examples

**Request**

```json
{
  "check_type": "sanction",
  "external_ref": "string"
}
```

**Response**

```json
{
  "id": "schk_abc123",
  "check_type": "sanction",
  "status": "pending",
  "has_match": true,
  "hit_count": 1,
  "provider": "string",
  "session_id": "string",
  "identity_id": "string",
  "external_ref": "string",
  "monitoring_enabled": true,
  "is_sandbox": true,
  "tags": [
    "string"
  ],
  "batch_id": "string",
  "pep_risk_tier": "tier_1",
  "pep_recommended_action": "string",
  "redacted_at": "2024-01-15T09:30:00Z",
  "last_checked_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "result": {},
  "hits": [
    {
      "id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "matched_name": "string",
      "name_similarity": 1.1,
      "dob_match": true,
      "combined_score": 1.1,
      "hit_source": "string",
      "hit_type": "string",
      "provider_ref": "string",
      "deceased": true,
      "is_false_positive": true,
      "pep_details": {
        "sources": [
          "string"
        ],
        "positions": [
          {
            "title": "string",
            "country": "string",
            "from": "string",
            "to": "string"
          }
        ],
        "associates": [
          {
            "name": "string",
            "relationship": "string"
          }
        ],
        "pep_class": "string"
      },
      "sanction_details": {
        "sources": [
          "string"
        ],
        "list_name": "string",
        "program": "string",
        "listed_on": "string"
      },
      "adverse_media_details": {
        "sources": [
          {
            "name": "string",
            "url": "string",
            "date": "string"
          }
        ]
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

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

payload = {
    "check_type": "sanction",
    "external_ref": "string"
}
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/checks';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"check_type":"sanction","external_ref":"string"}'
};

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/checks"

	payload := strings.NewReader("{\n  \"check_type\": \"sanction\",\n  \"external_ref\": \"string\"\n}")

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

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 = "{\n  \"check_type\": \"sanction\",\n  \"external_ref\": \"string\"\n}"

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/checks")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"check_type\": \"sanction\",\n  \"external_ref\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.withverifa.com/api/v1/checks', [
  'body' => '{
  "check_type": "sanction",
  "external_ref": "string"
}',
  '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/checks");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"check_type\": \"sanction\",\n  \"external_ref\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/checks")! 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()
```