API ReferenceCustom Fields

Create a custom field definition

Authentication

X-API-Keystring

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

Path parameters

type_idstringRequired

Identity type ID (idtype_*).

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:
Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Request

This endpoint expects an object.
namestringRequired

Machine-readable field name.

labelstringRequired

Human-readable label.

field_typeenumRequired
Data type for this field.
is_requiredbooleanOptionalDefaults to false
Whether this field is required on identities of this type.
is_uniquebooleanOptionalDefaults to false
Whether values must be unique across identities.
is_encryptedbooleanOptionalDefaults to false
Whether values are encrypted at rest.
enum_valueslist of stringsOptional

Allowed values when field_type is enum.

validation_regexstringOptional
Optional regex pattern for value validation.
sort_orderintegerOptional
Display order for the field.

Response

Custom field definition created.
idstring
org_idstring
identity_type_idstring
namestring
labelstring
field_typeenum
is_requiredboolean
created_atdatetime
is_uniqueboolean
is_encryptedboolean
enum_valueslist of strings
validation_regexstring
sort_orderinteger

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error