Update a document type
Updates mutable fields on a custom document type.
Required scope: settings:write (or legacy documents:write).
Updates mutable fields on a custom document type.
Required scope: settings:write (or legacy documents:write).
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Human-readable display label.
URL-safe identifier for this document type.
Human-readable display label.
Parent category for grouping in the dashboard. One of:
financial, corporate, identity, address, vehicle,
government, or other.
Free-text visual + content description of this document type. Used by Verifa’s document classifier to recognize uploaded documents and pick this type when it matches. Be specific about logos, layouts, and prominent fields — clearer descriptions give better classification accuracy.
Map of {field_name: hint} describing the structured fields to
extract from documents of this type. Each hint is a short
free-text description of how to identify the field — including
common synonyms, expected format, and any disambiguation tips
(“Member ID, sometimes labeled ‘Subscriber ID’ or ‘Policy #’”).
When set, uploaded documents of this type are passed through
Verifa’s document extractor and the resulting fields appear on
the document’s extracted_fields response field. All extraction
runs on Verifa’s private infrastructure — document content is
never sent to third-party services.
Optional override of the verification check suite for documents
of this type. Each entry is a [check_name, category, requirement]
tuple. When set, this overrides the org-level check_config and
the hardcoded default suite for the matching classification.