API ReferenceAPI Keys

Create API key

Creates a new API key. The full secret is returned only in this response — store it securely.

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.

Request

This endpoint expects an object.
labelstring or nullOptional

Human-readable label for the key.

notestring or nullOptional
Internal note about this key's purpose.
environmentenumOptionalDefaults to live
Environment the key is scoped to.
Allowed values:
scopeslist of strings or nullOptional
Permission scopes to grant.
api_versionstring or nullOptional
allowed_ipslist of strings or nullOptional
IP allowlist for this key.
expires_atstring or nullOptional
ISO 8601 expiration timestamp.

Response

API key created. The secret field is only returned here.

created_atdatetime
environmentenum
Allowed values:
idstring
is_activeboolean
key_prefixstring
First characters of the key for identification.
secretstring

Full API key secret. Only returned at creation time — store it securely as it cannot be retrieved again.

typeenum
Allowed values:
allowed_ipslist of strings or null
IP allowlist. Null means all IPs are allowed.
api_versionstring or null
default_key_inflectionenum
Allowed values:
expires_atdatetime or null
labelstring or null
last_used_atdatetime or null
notestring or null
scopeslist of strings or null
Permission scopes granted to this key.
warningstring
Reminder to store the secret securely.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error