Available Models
| Model | Use Case | Supported File Types |
|---|---|---|
light | Fast ID document parsing (driver licenses, passports, state IDs) | jpg, jpeg, png, webp, pdf |
performance | Comprehensive parsing for all document types (invoices, receipts, forms, contracts) | jpg, jpeg, png, webp, pdf |
Parsing a Document
Submit a file for parsing viaPOST /v1/parse:
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
model | string | Yes | light or performance |
file | file | Yes | The document to parse (max 50MB) |
tags | string | No | JSON object with metadata key-value pairs |
Response Structure
Field Reference
| Field | Type | Description |
|---|---|---|
parseId | integer | Unique identifier for the parse record |
mediaType | string | Media type category (image or document) |
fileType | string | File extension (jpeg, png, pdf, webp) |
fileName | string | Original uploaded file name |
fileSize | integer | File size in bytes |
timestamp | integer | Unix timestamp of the analysis |
timestampISO | string | ISO 8601 timestamp of the analysis |
model | string | Model used (light or performance) |
modelVersion | string | Version of the model used for analysis |
likelihood | float | Parsing confidence (see below) |
documentType | string | Identified document type (e.g. usa_driver_license, invoice) |
parsedData | object | Extracted key-value pairs (fields vary by document type) |
tags | object[] | Metadata tags attached to this parse |
files | object[] | Associated files (original upload) |
Understanding Results
Likelihood
100.0— Document was recognized and parsed successfully-1.0— Document type was not recognized or could not be parsed
Document Type
ThedocumentType field identifies the document (e.g. usa_driver_license, invoice, receipt, passport). If the document is unrecognized, this will be other.
Parsed Data
TheparsedData object contains the extracted key-value pairs. The fields depend on the document type.
ID Documents (light model):
| Field | Description |
|---|---|
firstName | First name |
lastName | Last name |
dateOfBirth | Date of birth (YYYY-MM-DD) |
licenseNumber | License or document number |
expirationDate | Document expiration date (YYYY-MM-DD) |
address | Full address |
invoiceNumber, totalAmount, dueDate, etc.
Tags and Filtering
Attach metadata to organize your parsing results:Browsing History
Retrieve paginated parsing results:Sort Options
parseId, mediaType, fileType, fileName, fileSize, confidence, documentType, timestamp