API ReferenceSessions

Redact session data

Permanently deletes all PII and document images for a session. This action is irreversible and intended for GDPR/CCPA right-to-deletion compliance.

Authentication

X-API-Keystring

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

Path parameters

session_idstringRequired

Session ID (ses_*).

Headers

Verifa-VersiondateOptional

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

Response

Session data redacted.
statusstring
session_idstring
documents_removedinteger
Number of document images deleted.
messagestring

Errors

401
Unauthorized Error
404
Not Found Error