Get a custom relationship type | Verifa

X-API-Keystring

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

type_idstringRequired

Relationship type ID (crel_*).

Relationship type details.

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

401

Unauthorized Error

404

Not Found Error

1	{
2	"id": "crel_9f8d7a6b",
3	"org_id": "org_4c3b2a1d",
4	"name": "owner_of_business",
5	"label": "Business",
6	"inverse_label": "Owner",
7	"is_active": true,
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"description": "Indicates the ownership relationship between an individual and a business entity."
11	}

1	{
2	"id": "crel_9f8d7a6b",
3	"org_id": "org_4c3b2a1d",
4	"name": "owner_of_business",
5	"label": "Business",
6	"inverse_label": "Owner",
7	"is_active": true,
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"description": "Indicates the ownership relationship between an individual and a business entity."
11	}

$	curl https://devapi.withverifa.com/api/v1/relationship-types/type_id \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json"