List identity relationships | Verifa

Returns relationships where this identity is the source. Relationships track links between verified identities for fraud detection, compliance audits, and manual account linking.

System-detected types (same_document, same_name_dob, same_ssn, merged) are created automatically. Only user_linked relationships can be created or 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.

Query parameters

typeenumOptional

Filter by relationship type.

limitintegerOptional<=100Defaults to 25

Maximum number of relationships to return.

offsetintegerOptional>=0Defaults to 0

Number of relationships to skip.

Response

A list of relationships.

datalist of objects

paginationobject

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://devapi.withverifa.com/api/v1/identities/identity_id/relationships"
4
5	headers = {"X-API-Key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"id": "idrel_abc123",
5	"related_identity_id": "idn_def456",
6	"relationship_type": "same_document",
7	"metadata": {},
8	"created_at": "2024-01-15T09:30:00Z"
9	}
10	],
11	"pagination": {
12	"total": 1,
13	"limit": 1,
14	"offset": 1
15	}
16	}

Authentication

Path parameters

Headers

Query parameters

Response

Errors