API ReferenceDocument Types

Update a document type

Updates mutable fields on a custom document type.

Required scope: settings:write

Authentication

X-API-Keystring

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

Path parameters

type_idstringRequired
Document type ID.

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.
labelstringOptional

Human-readable display label.

descriptionstring or nullOptional
Description of this document type.
categorystringOptional
Document category.
extraction_hintsmap from strings to any or nullOptional
OCR and extraction configuration hints.
check_suitemap from strings to any or nullOptional
Verification check suite configuration.
is_activebooleanOptional
Whether this document type is active.

Response

Document type updated.
idstring
Document type ID.
org_idstring
Organization ID.
slugstring

URL-safe identifier for this document type.

labelstring

Human-readable display label.

categorystring

Document category (e.g. identity, address, financial).

is_activeboolean
Whether this document type is active.
created_atdatetime
updated_atdatetime
descriptionstring or null
Description of this document type.
extraction_hintsmap from strings to any or null
OCR and extraction configuration hints.
check_suitemap from strings to any or null
Verification check suite configuration.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error