Bulk Erase Data

Endpoint

POST https://api.verifik.co/v2/data-retention/erase

Initiates an asynchronous bulk erasure operation. Permanently deletes stored DigitalOcean Spaces keys under the target prefix and unsets PII fields in MongoDB.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Request Body

Name	Type	Required	Description
scope	string	Yes	Target scope: "project" or "client"
projectId	string	Conditional	Required when scope is "project"
before	string (ISO 8601)	No	Optional cutoff timestamp. Erases data created prior to this date.
types	array	No	Optional filter for specific media types (e.g. ["documentImages", "faceImages"])

Request

Node.js

const fetch = require("node-fetch");

async function bulkErase() {
  const payload = {
    scope: "project",
    projectId: "6266193db77ccc8111730c90",
    before: "2026-01-01T00:00:00.000Z",
    types: ["documentImages", "faceImages"]
  };

  const res = await fetch("https://api.verifik.co/v2/data-retention/erase", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify(payload)
  });
  console.log(await res.json());
}

bulkErase();

Python

import os, requests

url = "https://api.verifik.co/v2/data-retention/erase"
headers = {
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}",
    "Content-Type": "application/json"
}
payload = {
    "scope": "project",
    "projectId": "6266193db77ccc8111730c90",
    "before": "2026-01-01T00:00:00.000Z",
    "types": ["documentImages", "faceImages"]
}

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

Response

200

{
  "data": {
    "jobId": "erase_6add0c680b29eb28766c82ce",
    "status": "QUEUED",
    "scope": "project",
    "projectId": "6266193db77ccc8111730c90",
    "estimatedRecords": 1420
  }
}

403

{
  "message": "Manual erase is disabled by policy",
  "code": "Forbidden"
}