API ReferenceAPI Keys

Update API key

Updates an API key's label, note, scopes, allowed IPs, or expiry. Only provided fields are changed.

Authentication

X-API-Keystring

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

Path parameters

api_key_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.
labelstring or nullOptional
notestring or nullOptional
scopeslist of strings or nullOptional
allowed_ipslist of strings or nullOptional
expires_atstring or nullOptional
ISO 8601 expiration timestamp. Set to null to remove expiry.

Response

Updated API key.
idstring
typeenum
Allowed values:
environmentenum
Allowed values:
key_prefixstring
First characters of the key for identification.
is_activeboolean
created_atdatetime
labelstring or null
notestring or null
scopeslist of strings or null
Permission scopes granted to this key.
api_versionstring or null
default_key_inflectionenum
Allowed values:
allowed_ipslist of strings or null
IP allowlist. Null means all IPs are allowed.
expires_atdatetime or null
last_used_atdatetime or null

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error