API ReferenceLists

Create a custom list

Creates a new custom screening list. Lists can be used in workflows to check subjects against custom criteria.

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:

Request

This endpoint expects an object.
namestringRequired
Name of the list.
list_typestringRequired

Type of list (e.g. blocklist, allowlist).

match_modestringOptionalDefaults to flag

Action when a match is found (flag or block).

descriptionstring or nullOptional

Response

List created.
idstring
namestring
list_typestring
match_modestring
item_countinteger
is_activeboolean
created_atdatetime
org_idstring
descriptionstring or null
updated_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error