API Reference

The Deep-OCR API lets you extract structured data from any document with a single HTTP request. POST a file — optionally with a document type — and receive a typed JSON object back. No configuration, no model training, no SDKs required.

curl -X POST "https://api.deep-ocr.com/v1/ocr?document_type=invoice" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@invoice.pdf"

All requests require an API key passed as a Bearer token in the Authorization header. You can create and manage keys in the Developer Center.

Authorization: Bearer deep_ocr_sk_live_xxxxxxxxxxxxxxxxxxxx

The single endpoint for all document extraction. Accepts a multipart/form-data body and always returns structured JSON.

Request Parameters

Code Examples

curl -X POST "https://api.deep-ocr.com/v1/ocr?document_type=invoice" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@invoice.pdf"

Each document_type uses a pre-defined extraction schema. The returned content object always matches that schema — every field is present, unknown fields are null.

Monetary values are returned as numbers (e.g. 583.10) so they can be used directly in calculations — the currency is always available separately in the currency field as an ISO 4217 code (e.g. EUR). Dates are ISO 8601 YYYY-MM-DD. Every field not found in the document is returned as null.

{ "description": "Software License Q1/2024", "quantity": 1, "unit_price": 490.00, "total": 490.00, "tax_rate": 19 }

{ "rate": 19, "net_amount": 490.00, "tax_amount": 93.10 }

{ "description": "Oat Milk 1L", "quantity": 2, "unit_price": 1.49, "total": 2.98, "tax_rate": 7 }

{ "rate": 7, "net_amount": 2.80, "tax_amount": 0.20 }

{ "role": "service_provider", "name": "ACME Ltd.", "address": "123 Main St, London EC1A 1BB", "representative": "Jane Smith" }

["Provide IT consulting services 40 hours per week", "Pay monthly fee of €5,000 by the 15th"]

{ "party": "ACME GmbH", "signed_date": "2024-01-15", "signed_by": "Max Müller" }

{ "date": "2024-03-15", "value_date": "2024-03-15", "description": "Direct debit rent March", "reference": "INV-2024-03", "amount": -950.00, "type": "debit", "balance": 2340.12 }

{ "description": "Base salary", "amount": 3500.00 }

{ "description": "Income tax", "amount": 650.00 }

{ "position": 1, "description": "Laptop Dell XPS 15", "article_number": "DEL-XPS-15", "quantity": 2, "unit": "pcs", "unit_price": 1200.00, "total": 2400.00, "tax_rate": 19 }

Every successful response is HTTP 200 with a JSON body. The top-level envelope is consistent across all document types.

Example — Invoice Response

{
  "filename": "invoice.pdf",
  "document_type": "invoice",
  "content": {
    "vendor": {
      "name": "ACME Solutions GmbH",
      "address": "123 Example Street, 10115 Berlin",
      "tax_id": "DE123456789",
      "email": "billing@acme.de",
      "phone": null
    },
    "customer": {
      "name": "Your Company Ltd.",
      "address": "42 High Street, 20354 Hamburg",
      "customer_number": "CUS-0042"
    },
    "invoice_number": "RE-2024-0815",
    "invoice_date": "2024-03-01",
    "due_date": "2024-03-31",
    "currency": "EUR",
    "line_items": [
      {
        "description": "Software License Q1/2024",
        "quantity": 1,
        "unit_price": 490.00,
        "total": 490.00,
        "tax_rate": 19
      }
    ],
    "subtotal": 490.00,
    "tax_breakdown": [
      { "rate": 19, "net_amount": 490.00, "tax_amount": 93.10 }
    ],
    "tax_amount": 93.10,
    "total": 583.10,
    "is_reverse_charge": false,
    "payment_terms": "14 days net",
    "bank_details": {
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX",
      "bank_name": "Commerzbank"
    },
    "is_paid": false,
    "notes": null,
    "items_truncated": false
  },
  "metadata": {
    "pages": 1,
    "processing_time": 1.84
  }
}

Error responses follow a consistent shape: { "detail": "Human-readable message" }

Rate limits are enforced per API key. Exceeding the limit returns HTTP 429. Limits reset every minute.

Use Deep-OCR with the tools you already know — from no-code automation to AI-assisted development.