Quickstart
Create a key, set two environment variables, and send a verified first request.
export SCANVERION_API_URL="https://api.scanverion.com"
export SCANVERION_API_KEY="skv_..."
curl --request POST "$SCANVERION_API_URL/api/v1/ai/document-processing" \
--header "Authorization: Bearer $SCANVERION_API_KEY" \
--header "Idempotency-Key: first-document-001" \
--form "File=@document.jpg;type=image/jpeg" \
--form "Operations=Scanner"Browse the integration guide · Response model · Errors and retry strategy
Getting started
- Quickstart
Create a key, set two environment variables, and send a verified first request.
- Authentication and API keys
Use scoped machine credentials safely from a trusted backend.
- Idempotency and retries
Give every processing attempt a stable key and handle duplicates deliberately.
Documents and images
- Document processing
Upload JPEG, PNG, WebP, or PDF input for synchronous document analysis.
- Document and country coverage
See public document specimens, generic visual operations, tested national layouts, and global standards-based passport support.
- Operations and dependencies
Choose supported operations and understand automatically added dependencies.
- Response model
Read per-object results, operation outcomes, timing, and charged credits.
- Batch processing
Process multiple document or vehicle files in one synchronous request.
- Vehicle processing
Run detection or blur analysis against a vehicle image.
- Validation resources
Call dedicated lost-card and postal-code validation endpoints.
Identity and biometrics
- Face comparison
Compare two authorized portraits independently of document detection, with similarity, face geometry, and review reasons.
- Liveness
A short camera session checks for presentation attacks. Face matching remains a separate assessment.
- Signature comparison
Compare one candidate signature with three to five references for experimental visual similarity.
- Face templates and database search
Integrate reusable signed face templates, store one vector per person and search your own database with pgvector.
Usage and reliability
- Usage and credits
Query calls, weighted credits, daily totals, capability totals, and price previews.
- Errors and retry strategy
Handle authentication, entitlement, validation, duplicate, and provider failures.
Reference and tools
- OpenAPI reference
Open the generated Scalar explorer or download the machine-readable contract.
- MCP integration
Hosted OAuth connections, client registration, scopes, and local stdio setup for VS Code and Claude Desktop.
SDKs, CLI and collections
Developer tooling
Choose a path. Ship the same contract.
Move from a sample to a verified server-side request with one API contract across every tool.
MCP setupPostman
Import, configure, run
The collection contains only AI processing, validation, capability, health, and usage workflows.
- 1
Import both JSON filesSelect Scanverion Local in Postman.
- 2
Set your variablesAdd the API key and absolute sample-file paths.
- 3
Run 00 - SetupCheck health first, then verify the key with capabilities.
- 4
Choose a workflowRun Document AI, Vehicle AI, Validation, or Usage.
- baseUrl
https://api.scanverion.com- apiKey
skv_...processing key- sampleDocument
- Absolute PDF or image path
- sampleDocument2
- Second file for batch requests
- sampleVehicle
- Absolute vehicle image path
- fromDate / toDate
YYYY-MM-DDusage period
$env:SCANVERION_API_URL = "https://api.scanverion.com"
$env:SCANVERION_API_KEY = "skv_..."
curl.exe --request POST "$env:SCANVERION_API_URL/api/v1/ai/document-processing" `
--header "Authorization: Bearer $env:SCANVERION_API_KEY" `
--header "Idempotency-Key: first-request-001" `
--form "File=@invoice.pdf;type=application/pdf" `
--form "Operations=Scanner"