> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# List identity relationships

GET https://api.withverifa.com/api/v1/identities/{identity_id}/relationships

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.


Reference: https://docs.withverifa.com/api-reference/identities/list-identity-relationships

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Path parameters

- `identity_id` (string, required) — Identity ID (`idn_*`) or external reference.

### Query parameters

- `type` (enum, optional) — Filter by relationship type.
  - Allowed values: `same_document`, `same_name_dob`, `same_ssn`, `same_device`, `merged`, `user_linked`
- `limit` (integer, optional, default: 25) — Maximum number of relationships to return.
- `offset` (integer, optional, default: 0) — Number of relationships to skip.

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.
- `Key-Inflection` (enum, optional, default: snake) — Response key casing. Defaults to `snake`.
  - Allowed values: `camel`, `kebab`, `snake`

## Response

### 200

A list of relationships.

- `data` (list of IdentityRelationship, required)
- `pagination` (ApiV1IdentitiesIdentityIdRelationshipsGetResponsesContentApplicationJsonSchemaPagination, required)

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 404 Not Found Error

Resource not found.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Invalid relationship type filter.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Types

### IdentityRelationship

- `id` (string, required)
- `related_identity_id` (string, required)
- `relationship_type` (string, required) — Built-in type (e.g. `user_linked`, `same_device`, `merged`, `family_member`) or the `name` of an org-defined custom type.
- `metadata` (map from string to any, required)
- `related_external_ref` (string, optional, nullable) — External reference of the related identity.
- `relationship_label` (string, optional, nullable) — Human-readable label for custom types (null for built-ins).
- `relationship_inverse_label` (string, optional, nullable) — Label shown from the reverse direction for custom types.
- `is_custom_type` (boolean, optional) — True if this relationship uses an org-defined custom type.
- `note` (string, optional, nullable) — Note attached to user-created relationships.
- `created_at` (datetime, optional, nullable)

### ApiV1IdentitiesIdentityIdRelationshipsGetResponsesContentApplicationJsonSchemaPagination

- `total` (integer, required) — Total number of matching items.
- `limit` (integer, required)
- `offset` (integer, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "idrel_abc123",
      "related_identity_id": "idn_def456",
      "relationship_type": "string",
      "metadata": {},
      "related_external_ref": "string",
      "relationship_label": "string",
      "relationship_inverse_label": "string",
      "is_custom_type": true,
      "note": "string",
      "created_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/identities/identity_id/relationships"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/identities/identity_id/relationships';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/identities/identity_id/relationships"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/identities/identity_id/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.withverifa.com/api/v1/identities/identity_id/relationships")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.withverifa.com/api/v1/identities/identity_id/relationships', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/identities/identity_id/relationships");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/identities/identity_id/relationships")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```