Compare a document to a verified identity

POST

https://devapi.withverifa.com/api/v1/documents/:document_id/compare-to-identity

Extracts fields from the document and compares name, address, DOB, and document number against a stored identity record.

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_*).

This endpoint expects an object.

identity_idstringRequired

ID of the identity to compare against.

thresholddoubleOptional

Identity comparison result.

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.

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://devapi.withverifa.com/api/v1/documents/document_id/compare-to-identity \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"identity_id": "id_9f8e7d6c5b4a3210"
>	}'

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