API ReferenceIdentities

Create an identity

Creates a stub identity record before any verification session exists. The identity will be populated automatically when a session with a matching external_ref completes verification.

Returns 409 Conflict if an identity with the given external_ref already exists.

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.
external_refstringRequired
Your system's unique identifier for this person.
upsertbooleanOptionalDefaults to false

When true, returns existing identity if one exists for this external_ref (200) instead of returning 409.

Response

Existing identity returned (when upsert is true).

idstring
external_refstring
statusstring
is_sandboxboolean
created_atdatetime
upsertedboolean

Errors

401
Unauthorized Error
409
Conflict Error