Run AI-powered document insights

POST

https://devapi.withverifa.com/api/v1/documents/:document_id/insights

POST

/api/v1/documents/:document_id/insights

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

1 {
2   "id": "ext_9f8b7c6d5a4e3f21",
3   "document_id": "doc_1234567890abcdef",
4   "extraction_type": "insights",
5   "status": "completed",
6   "created_at": "2024-01-15T09:30:00Z",
7   "extracted_fields": {
8     "authenticity_assessment": "Document appears genuine with no signs of tampering.",
9     "content_consistency": "All fields are consistent with expected document format.",
10     "type_specific_insights": {
11       "passport_number_valid": true,
12       "expiry_date": "2030-12-31",
13       "issuing_country": "USA"
14     }
15   },
16   "confidence_scores": {
17     "authenticity_assessment": 0.98,
18     "content_consistency": 0.95,
19     "passport_number_valid": 0.99,
20     "expiry_date": 0.97,
21     "issuing_country": 0.96
22   },
23   "reference_document_id": null,
24   "comparison_results": null
25 }

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

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

{
  "id": "ext_9f8b7c6d5a4e3f21",
  "document_id": "doc_1234567890abcdef",
  "extraction_type": "insights",
  "status": "completed",
  "created_at": "2024-01-15T09:30:00Z",
  "extracted_fields": {
    "authenticity_assessment": "Document appears genuine with no signs of tampering.",
    "content_consistency": "All fields are consistent with expected document format.",
    "type_specific_insights": {
      "passport_number_valid": true,
      "expiry_date": "2030-12-31",
      "issuing_country": "USA"
    }
  },
  "confidence_scores": {
    "authenticity_assessment": 0.98,
    "content_consistency": 0.95,
    "passport_number_valid": 0.99,
    "expiry_date": 0.97,
    "issuing_country": 0.96
  },
  "reference_document_id": null,
  "comparison_results": null
}

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

Response

Insights extraction.

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

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Run AI-powered document insights

Run AI-powered document insights

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

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

1	{
2	"id": "ext_9f8b7c6d5a4e3f21",
3	"document_id": "doc_1234567890abcdef",
4	"extraction_type": "insights",
5	"status": "completed",
6	"created_at": "2024-01-15T09:30:00Z",
7	"extracted_fields": {
8	"authenticity_assessment": "Document appears genuine with no signs of tampering.",
9	"content_consistency": "All fields are consistent with expected document format.",
10	"type_specific_insights": {
11	"passport_number_valid": true,
12	"expiry_date": "2030-12-31",
13	"issuing_country": "USA"
14	}
15	},
16	"confidence_scores": {
17	"authenticity_assessment": 0.98,
18	"content_consistency": 0.95,
19	"passport_number_valid": 0.99,
20	"expiry_date": 0.97,
21	"issuing_country": 0.96
22	},
23	"reference_document_id": null,
24	"comparison_results": null
25	}