API ReferenceIdentities

Set custom field values

Sets or updates custom field values on an identity. Values are validated against field definitions. Encrypted fields are stored using AES-256-GCM.

Authentication

X-API-Keystring

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

Path parameters

identity_idstringRequired

Identity ID (idn_*) or external reference.

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.
custom_fieldsmap from strings to anyRequired
Map of custom field names to values.

Response

Updated custom fields.
identity_idstring
custom_fieldsmap from strings to any

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error