API ReferenceRelationship Types

Create a custom relationship type

Creates a new org-defined relationship type. The name must match ^[a-z][a-z0-9_]{1,63}$ and cannot collide with a built-in type. Leave inverse_label blank to create a symmetric type.

Required scope: settings:write (or legacy identities:write).

Authentication

X-API-Keystring

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

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.
namestringRequired

Machine-readable slug (unique per org/environment).

labelstringRequired
What the related identity is to the source.
inverse_labelstringOptional

What the source is to the related identity. Defaults to label if omitted.

descriptionstringOptional

Response

Relationship type created.
idstring
org_idstring
namestring

Machine-readable slug, unique per org/environment.

labelstring

Human-readable label for the outgoing direction (what the related identity is to the source).

inverse_labelstring

Label for the reverse direction. Equal to label for symmetric types.

is_activeboolean
created_atdatetime
updated_atdatetime
descriptionstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error