For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • GETList identities
      • POSTCreate an identity
      • GETGet an identity
      • PATCHUpdate an identity
      • DELRedact an identity
      • GETExport identity data (GDPR Art. 15 DSAR)
      • POSTSearch identities
      • GETList identity sessions
      • GETGet identity audit log
      • POSTAdd a tag
      • POSTRemove a tag
      • POSTSet tags
      • POSTPreview identity merge
      • POSTMerge identities
      • POSTArchive an identity
      • POSTRestore an archived identity
      • POSTPause continuous monitoring for an identity
      • POSTResume continuous monitoring for an identity
      • POSTAdvanced identity search
      • GETGet custom field values
      • PATCHSet custom field values
      • GETList identity relationships
      • POSTCreate an identity relationship
      • DELDelete an identity relationship
      • GETQuery identity relationship graph
      • GETFind cross-session image similarity matches
      • GETGet monitored lists for an identity
      • POSTAdd lists to identity monitoring
      • PUTReplace monitored lists for an identity
API ReferenceIdentities

List identity relationships

GET
https://devapi.withverifa.com/api/v1/identities/:identity_id/relationships
GET
/api/v1/identities/:identity_id/relationships
$curl https://devapi.withverifa.com/api/v1/identities/identity_id/relationships \
>     -H "X-API-Key: <apiKey>"
1{
2  "data": [
3    {
4      "id": "idrel_abc123",
5      "related_identity_id": "idn_def456",
6      "relationship_type": "string",
7      "metadata": {},
8      "related_external_ref": "string",
9      "relationship_label": "string",
10      "relationship_inverse_label": "string",
11      "is_custom_type": true,
12      "note": "string",
13      "created_at": "2024-01-15T09:30:00Z"
14    }
15  ],
16  "pagination": {
17    "total": 1,
18    "limit": 1,
19    "offset": 1
20  }
21}
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.
Was this page helpful?
Previous

Create an identity relationship

Next
Built with

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.

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:

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