API ReferenceIdentities

List identities

Returns a paginated list of verified identities for your organization. Identities aggregate verification sessions for the same individual.

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:

Query parameters

statusstringOptional
Filter by identity status.
qstringOptional
Search by external reference.
include_archivedbooleanOptionalDefaults to false
Include archived identities in results.
limitintegerOptional1-100Defaults to 25
Maximum number of identities to return.
offsetintegerOptional>=0Defaults to 0
Number of identities to skip.
page[after]stringOptional

Cursor for forward pagination. When provided, uses cursor-based pagination instead of offset.

page[before]stringOptional
Cursor for backward pagination.
page[size]integerOptional<=100Defaults to 25
Page size for cursor pagination.

Response

A list of identities.
datalist of objects
paginationobject

Errors

401
Unauthorized Error
429
Too Many Requests Error