API ReferenceIdentities

Delete an identity relationship

Deletes a user_linked relationship. Both directions (A→B and B→A) are removed. System-created relationships (same_document, same_name_dob, same_ssn, merged) cannot be deleted via the API.

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.

relationship_idstringRequired
The relationship ID.

Headers

Verifa-VersiondateOptional

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

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

Relationship deleted.
deletedboolean

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error