API ReferenceIdentities

Restore an archived identity

Restores a previously archived identity, making it visible in list results again.

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 restored.
idstring
statusstring
session_countinteger
is_sandboxboolean
created_atdatetime
external_refstring or null
latest_session_idstring or null
latest_result_idstring or null
face_match_passedboolean or null
age_check_passedboolean or null
extracted_ageinteger or null
rejection_reasonstring or null
countrystring or null
extracted_dataobject

PII extracted from the identity document. Fields returned depend on your organization’s api_pii_fields configuration.

first_verified_atdatetime or null
last_verified_atdatetime or null
archived_atdatetime or null
identity_type_idstring or null
custom_fieldsmap from strings to any
tagslist of strings
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error