API ReferenceDocuments

Compare two documents

Compares the current document against a reference document. Useful for cross-referencing extracted fields between an ID document and a proof-of-address, or between two identity documents.

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.

Request

This endpoint expects an object.
reference_document_idstringRequired
ID of the document to compare against.
thresholddoubleOptional
Minimum similarity threshold for a passing comparison.

Response

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

Errors

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