Trigger document extraction | Verifa

Runs OCR and field extraction on the document. Creates a new DocumentExtraction record with the extracted fields and confidence scores.

Required scope: documents:write

X-API-Keystring

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

document_idstringRequired

Document ID (doc_*).

Extraction result.

idstring

Extraction record ID.

document_idstring

Parent document ID.

extraction_typestring

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

statusenum

Allowed values:

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.

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

1	{
2	"id": "string",
3	"document_id": "string",
4	"extraction_type": "string",
5	"status": "pending",
6	"created_at": "2024-01-15T09:30:00Z",
7	"extracted_fields": {},
8	"confidence_scores": {},
9	"reference_document_id": "string",
10	"comparison_results": {}
11	}