API ReferenceIdentities

Create an identity relationship

Creates a bidirectional user_linked relationship between two identities. System relationship types (same_document, same_name_dob, same_ssn, merged) cannot be created 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.

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:
Idempotency-KeystringOptional<=255 characters

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

Request

This endpoint expects an object.
related_identity_idstringRequired
The identity to link to.
relationship_typeenumOptionalDefaults to user_linked

Only user_linked is allowed via API.

Allowed values:
metadatamap from strings to anyOptional
Optional metadata to attach to the relationship.

Response

Relationship created.
idstring
source_identity_idstring
related_identity_idstring
relationship_typestring
metadataobject

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error