Skip to main content
POST
/
v1
/
parse
Parse Document
curl --request POST \
  --url https://api.deepxl.ai/v1/parse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'model=<string>' \
  --form file='@example-file' \
  --form 'tags={}'
{
  "result": {
    "parseId": 117,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileName": "drivers_license.jpg",
    "fileSize": 231433,
    "model": "light",
    "likelihood": 100,
    "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"
    },
    "timestamp": 1725795600,
    "timestampISO": "2024-09-08T10:00:00.000000",
    "tags": [
      {
        "name": "customerId",
        "value": "9999"
      },
      {
        "name": "customerName",
        "value": "Acme Corp"
      },
      {
        "name": "documentId",
        "value": "DOC-2024-001"
      },
      {
        "name": "companyName",
        "value": "DeepXL"
      },
      {
        "name": "companyId",
        "value": "COMP-001"
      }
    ],
    "files": [
      {
        "category": "original_file",
        "fileName": "drivers_license.jpg",
        "fileSize": 231433,
        "contentType": "image/jpeg",
        "timestamp": 1725795600,
        "timestampISO": "2024-09-08T10:00:00.000000",
        "url": "https://api.deepxl.ai/v1/files/parse_117_drivers_license.jpg"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
model
string
required

AI model to use for parsing. Available models: 'light' (fast, ID documents only - driver licenses, passports, state IDs) or 'performance' (comprehensive, all document types - invoices, receipts, forms, contracts)

​
file
file
required
​
tags
string | null
default:{}

Optional JSON object with key-value pairs for organizing and querying results. Example: {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}. Common keys: customerId, customerName, documentId, companyName, companyId.

Response

Document processed. Check 'likelihood' field: 1.0 = successful parse, -1.0 = document rejected/not recognized.

​
result
APIParse · object
required

The document parse result