API ReferenceDocuments

Redact a document

Permanently redacts the document file and associated PII. The document record is retained with status redacted for audit purposes.

Required scope: documents:write

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

document_idstringRequired

Document ID (doc_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Document redacted.
idstring
statusstring
redacted_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error