Documentation
Guides and API reference for extracting structured data from passports, driver's licenses, PAN cards, Aadhaar cards, 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; Indian PAN and Aadhaar cards use dedicated India-specific schemas; 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 and parse passport pages into structured JSON: biodata, MRZ, and identity fields worldwide | /v1/documents/passport | Global | 1 credit per image |
| Driver's License | OCR and parse driver's licenses and driving licences with country-specific schemas | /v1/documents/driver-license | IND, USA, VNM, GBR, THA, IDN | 1 credit per PDF page or image |
| PAN Card | OCR and parse Indian Permanent Account Number (PAN) cards into structured JSON | /v1/documents/pan | Global | 1 credit per PDF page or image |
| Aadhaar | OCR and parse Indian Aadhaar (UIDAI) cards into structured JSON | /v1/documents/aadhaar | Global | 1 credit per image |
| Vehicle RC | Extract structured vehicle and registration information from Indian Registration Certificates | /v1/documents/indian-vehicle-rc | Global | 1 credit per image |
| Invoice | Parse PDF and image invoices into structured JSON: any layout, vendor, or language | /v1/documents/invoice | Global | 1 credit per PDF page or image |
| Receipt | Parse receipts and expense documents into structured JSON: any merchant or format | /v1/documents/receipt | Global | 1 credit per PDF page or image |
| Custom | Define your own document types with JSON Schema and get a production extraction endpoint | /v1/custom-extractors/<id> | Global | Credits based on document size |
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.
Custom extractors
Define your own document types with a JSON Schema, field-level formats/regex, and soft or hard validation.
See Custom extractor schemas for the full reference, or open the schema editor in Console.
Credits
Usage is metered in credits: 1 credit per PDF page or 1 credit per image. Credits expire 30 days after they're issued.
See Credits for details, or pricing for plans.
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.