API ReferenceIdentity Types

Update an identity type

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:

Request

This endpoint expects an object.
labelstringOptional
descriptionstringOptional
statuseslist of stringsOptional
default_statusstringOptional
is_defaultbooleanOptional
Whether this is the default identity type for the organization.

Response

Updated identity type.
idstring
org_idstring
namestring
labelstring
is_defaultboolean
created_atdatetime
descriptionstring
statuseslist of strings
default_statusstring
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error