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

# GDPR redact check PII

POST https://api.withverifa.com/api/v1/checks/{check_id}/redact

Permanently removes all personally identifiable information from a check.

**Required scope:** `redact:write` (or legacy `checks:write` / `screening:write`).


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

## Authentication

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

## Request

### Path parameters

- `check_id` (string, required) — Check ID (`schk_*`).

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

## Response

### 200

Check PII redacted.

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

### 404 Not Found Error

Resource not found.

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

## Types

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

**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/check_id/redact"

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

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

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/checks/check_id/redact';
const options = {method: 'POST', 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/checks/check_id/redact"

	req, _ := http.NewRequest("POST", 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/checks/check_id/redact")

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

request = Net::HTTP::Post.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.post("https://api.withverifa.com/api/v1/checks/check_id/redact")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/checks/check_id/redact");
var request = new RestRequest(Method.POST);
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/checks/check_id/redact")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```