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 custom relationship types
      • POSTCreate a custom relationship type
      • GETGet a custom relationship type
      • DELDelete a custom relationship type
      • PATCHUpdate a custom relationship type
API ReferenceRelationship Types

Create a custom relationship type

POST
https://devapi.withverifa.com/api/v1/relationship-types
POST
/api/v1/relationship-types
$curl -X POST https://devapi.withverifa.com/api/v1/relationship-types \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "owner_of_business",
>  "label": "Business"
>}'
1{
2  "id": "crel_abc123",
3  "org_id": "org_abc123",
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": "string"
11}

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

Was this page helpful?
Previous

Get a custom relationship type

Next
Built with

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