API ReferenceLists

Add an item to a custom list

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

list_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Request

This endpoint expects an object.
valuemap from strings to anyRequired

Item data (structure depends on list type).

notesstring or nullOptional

Response

Item created.
idstring
valuemap from strings to any
The item's value, decrypted from encrypted storage. Schema depends on the list type.
created_atdatetime
list_idstring
match_countinteger
Number of times this item has been matched against a session or identity.
last_matched_atdatetime or null
When this item was last matched.
notesstring or null
is_activeboolean
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error