API ReferenceIdentity Types

Create an identity type

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:
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 name for the identity type.

labelstringRequired

Human-readable label.

descriptionstringOptional
Optional description of this identity type.
statuseslist of stringsOptional
Custom statuses for this identity type.
default_statusstringOptional
Default status for new identities of this type.
is_defaultbooleanOptionalDefaults to false
Whether this is the default identity type for the organization.

Response

Identity type created.
idstring
org_idstring
namestring
labelstring
is_defaultboolean
created_atdatetime
descriptionstring
statuseslist of strings
default_statusstring
updated_atdatetime

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error