API ReferenceDocument Types

Create a document type

Creates a new custom document type for your organization. Document types define how documents of a given kind are classified, extracted, and verified.

Required scope: settings:write

Authentication

X-API-Keystring

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

Headers

Idempotency-KeystringOptional<=255 characters

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

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.
slugstringRequiredformat: "^[a-z0-9_-]+$"

URL-safe identifier for this document type.

labelstringRequired

Human-readable display label.

categorystringRequired

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

descriptionstringOptional
Optional description of this document type.
extraction_hintsmap from strings to anyOptional
OCR and extraction configuration hints.
check_suitemap from strings to anyOptional
Verification check suite configuration.

Response

Document type created.
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
422
Unprocessable Entity Error