API access

Submit invoices programmatically. Use your secret token to authenticate every request.

Your API token

Treat this like a password. Anyone with this token can submit invoices on your behalf.

POSTSubmit by file upload

Send a PDF file as multipart form data. The invoice is queued immediately and the response includes its ID.

POSThttp://localhost:5002/api/v1/invoices/upload

Headers

Authorization
Bearer {}your_api_token}
Content-Type
multipart/form-data

Form fields

file (required)
The PDF file to process. Max 25 MB.

Example request

curl -X POST http://localhost:5002/api/v1/invoices/upload \
  -H "Authorization: Bearer sk_live_4f8a...abc123" \
  -F "file=@./maersk-invoice-april-2026.pdf"

Example response · 201 Created

{
  "success": true,
  "data": {
    "invoiceId": "Iox4_g6lHFU0QiLROwwyX",
    "jobId": "VYD4RsZBgLKs0R_Wy149A",
    "status": "pending"
  }
}

POSTSubmit by file URL

Pass a publicly-reachable PDF URL. We fetch the file ourselves, then process it.

POSThttp://localhost:5002/api/v1/invoices/from-url

Headers

Authorization
Bearer {}your_api_token}
Content-Type
application/json

Body

url (required)
Absolute https:// URL to a PDF file. Must be reachable from our network.

Example request

curl -X POST http://localhost:5002/api/v1/invoices/from-url \
  -H "Authorization: Bearer sk_live_4f8a...abc123" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://files.acme.com/invoices/cma-cgm-7841.pdf" }'

Example response · 202 Accepted

{
  "success": true,
  "data": {
    "invoiceId": "Iox4_g6lHFU0QiLROwwyX",
    "jobId": "VYD4RsZBgLKs0R_Wy149A",
    "status": "pending",
    "source": "api_url",
    "sourceUrl": "https://files.acme.com/invoices/cma-cgm-7841.pdf"
  }
}

GETFetch invoice status

Poll the status & extracted JSON of an invoice you previously submitted. You'll also receive this payload via webhook once processing finishes — polling is optional.

GEThttp://localhost:5002/api/v1/invoices/{id}

Example request

curl http://localhost:5002/api/v1/invoices/127 \
  -H "Authorization: Bearer sk_live_4f8a...abc123"

Example response · 200 OK

{
  "id": 127,
  "status": "auto_approved",
  "confidence": 0.92,
  "extracted": {
    "invoice_number": "MAEU-2026-04-15893",
    "invoice_date": "2026-04-12",
    "vendor":   { "name": "Maersk Line",  "gstin": "27AABMA1234F1Z5" },
    "customer": { "name": "Acme Logistics", "gstin": "27ZZACME1234M1Z5" },
    "totals":   { "total_taxable_value_inr": 261000, "total_inr": 307980 }
  },
  "processed_at": "2026-05-26T08:33:02Z"
}