API ReferenceDocuments

Run AI-powered document insights

Runs LLM-powered insights analysis on a document and persists the result as a DocumentExtraction with extraction_type: "insights". Returns authenticity assessment, content consistency, and type-specific insights.

Required scope: documents:write

Authentication

X-API-Keystring

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

Path parameters

document_idstringRequired

Document ID (doc_*).

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.

Response

Insights extraction.
idstring
Extraction record ID.
document_idstring
Parent document ID.
extraction_typestring

Type of extraction performed (e.g. ocr, barcode, mrz).

statusenum
created_atdatetime
extracted_fieldsmap from strings to any

Key-value map of extracted data fields.

confidence_scoresmap from strings to doubles

Per-field confidence scores (0-1).

reference_document_idstring or null
Reference document used for comparison, if any.
comparison_resultsmap from strings to any or null

Field-by-field comparison results when comparing two documents.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error