Documentation
Guides and API reference for extracting structured data from passports, driver's licenses, invoices, and receipts.
Overview
Cryvis turns document images and PDFs into validated JSON through purpose-built extraction APIs. Each document type has its own endpoint with a typed schema (names, dates, line items, totals, and more) without building OCR pipelines yourself.
Upload files as multipart form data, authenticate with a Bearer API key, and receive structured JSON in seconds. Passports, invoices, and receipts work globally; driver's licenses use country-specific parsers when you pass the issuing country for higher accuracy.
Available APIs
| API | Description | Endpoint | Coverage | Usage |
|---|---|---|---|---|
| Passport OCR API | OCR and parse passport pages into structured JSON: biodata, MRZ, and identity fields worldwide | /v1/documents/passport | Global | 2 (biodata + final page) |
| Driver's License OCR API | OCR and parse driver's licenses and driving licences with country-specific schemas | /v1/documents/driver-license | IND, USA, VNM | 1 per page |
| Invoice OCR API | Parse PDF and image invoices into structured JSON: any layout, vendor, or language | /v1/documents/invoice | Global | 1 per page |
| Receipt OCR API | Parse receipts and expense documents into structured JSON: any merchant or format | /v1/documents/receipt | Global | 1 per page |
Each endpoint accepts file uploads via multipart/form-data and returns typed JSON with validation metadata. Select a row to open the full API reference with request parameters, response schemas, and an interactive playground.
Credits
Credits are charged per page parsed. Passport extraction always costs 2 credits, one for the biodata page and one for the final page. All other endpoints charge 1 credit per uploaded page, so a 3-page invoice uses 3 credits and a 5-page receipt PDF uses 5 credits.
See pricing for plan allowances and overage rates.
Getting started
- Create a free account and verify your email.
- Generate an API key from the Console.
- Pick the endpoint for your document type from the table above.
- Send a
POSTrequest with your file attached.
See Quickstart for a step-by-step walkthrough with curl examples.
Authentication
All requests require a Bearer token in the Authorization header:
Authorization: Bearer sk_live_...Generate keys in the Console. Keys are shown once at creation; store them securely.