Skip to main content
The Parsing Model extracts and parses structured data from IDs and documents — names, dates, addresses, amounts, and more.

Available Models

ModelUse CaseSupported File Types
lightFast ID document parsing (driver licenses, passports, state IDs)jpg, jpeg, png, webp, pdf
performanceComprehensive parsing for all document types (invoices, receipts, forms, contracts)jpg, jpeg, png, webp, pdf
Retrieve the full list of models programmatically:
curl https://api.deepxl.ai/v1/parsing-models \
  -H "x-api-key: YOUR_API_KEY"

Parsing a Document

Submit a file for parsing via POST /v1/parse:
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=light" \
  -F "file=@drivers_license.jpg" \
  -F 'tags={"customerId":"9999"}'

Parameters

ParameterTypeRequiredDescription
modelstringYeslight or performance
filefileYesThe document to parse (max 50MB)
tagsstringNoJSON object with metadata key-value pairs

Response Structure

{
  "result": {
    "parseId": 123,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileName": "drivers_license.jpg",
    "fileSize": 231433,
    "timestamp": 1770984134,
    "timestampISO": "2026-02-13T13:02:14.833162",
    "model": "light",
    "modelVersion": "1.2.0",
    "likelihood": 100.0,
    "documentType": "usa_driver_license",
    "parsedData": {
      "firstName": "JOHN",
      "lastName": "DOE",
      "dateOfBirth": "1990-05-15",
      "licenseNumber": "D1234567",
      "expirationDate": "2028-05-15",
      "address": "123 MAIN ST ANYTOWN, CA 90210"
    },
    "tags": [
      { "name": "customerId", "value": "9999" }
    ],
    "files": [
      {
        "category": "original_file",
        "fileName": "drivers_license.jpg",
        "fileSize": 231433,
        "contentType": "image/jpeg",
        "timestamp": 1770984134,
        "timestampISO": "2026-02-13T13:02:14.833162",
        "url": "https://api.deepxl.ai/v1/files/parse_123_drivers_license.jpg"
      }
    ]
  }
}

Field Reference

FieldTypeDescription
parseIdintegerUnique identifier for the parse record
mediaTypestringMedia type category (image or document)
fileTypestringFile extension (jpeg, png, pdf, webp)
fileNamestringOriginal uploaded file name
fileSizeintegerFile size in bytes
timestampintegerUnix timestamp of the analysis
timestampISOstringISO 8601 timestamp of the analysis
modelstringModel used (light or performance)
modelVersionstringVersion of the model used for analysis
likelihoodfloatParsing confidence (see below)
documentTypestringIdentified document type (e.g. usa_driver_license, invoice)
parsedDataobjectExtracted key-value pairs (fields vary by document type)
tagsobject[]Metadata tags attached to this parse
filesobject[]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

The documentType field identifies the document (e.g. usa_driver_license, invoice, receipt, passport). If the document is unrecognized, this will be other.

Parsed Data

The parsedData object contains the extracted key-value pairs. The fields depend on the document type. ID Documents (light model):
FieldDescription
firstNameFirst name
lastNameLast name
dateOfBirthDate of birth (YYYY-MM-DD)
licenseNumberLicense or document number
expirationDateDocument expiration date (YYYY-MM-DD)
addressFull address
General Documents (performance model): The extracted fields vary by document type. Invoices may include invoiceNumber, totalAmount, dueDate, etc.

Tags and Filtering

Attach metadata to organize your parsing results:
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=performance" \
  -F "file=@invoice.pdf" \
  -F 'tags={"customerId":"9999","documentId":"INV-2024-042"}'
Filter your parse history:
curl "https://api.deepxl.ai/v1/parse?tagFilter=customerId=9999" \
  -H "x-api-key: YOUR_API_KEY"

Browsing History

Retrieve paginated parsing results:
curl "https://api.deepxl.ai/v1/parse?limit=25&offset=0&sortBy=parseId&direction=desc" \
  -H "x-api-key: YOUR_API_KEY"

Sort Options

parseId, mediaType, fileType, fileName, fileSize, confidence, documentType, timestamp