API ReferenceIdentities

Archive an identity

Archives a verified identity. Archived identities are excluded from list results by default. Cannot archive redacted identities.

Authentication

X-API-Keystring

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

Path parameters

identity_idstringRequired

Identity ID (idn_*) or external reference.

Headers

Verifa-VersiondateOptional

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

Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Response

Identity archived.
idstring
statusstring

Lifecycle status is preserved on archive; archived_at is what marks the identity as archived.

archived_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error