Docs/Partner API Reference

Partner API Reference

OpenAPI Specification

The full machine-readable Partner API spec is published at [nexosscan.com/openapi.yaml](/openapi.yaml) (OpenAPI 3.1). Import it into Postman, Insomnia, or your IDE to generate clients in any language.

Overview

The NEXOS Partner API allows businesses and developers to integrate NexosIQ's document extraction capabilities directly into their own platforms, workflows, and products. Submit invoices and receipts via API and receive structured, verified JSON data in response.

Use Cases

White-label invoice processing for your own clients
Automated document ingestion pipelines
ERP and accounting system integrations
Expense management platform integrations
POS system receipt processing

Authentication

All API requests require a Bearer token in the Authorization header:

http

Authorization: Bearer YOUR_API_KEY

Retrieve your API key from Settings → API Keys.

Endpoints

Submit Invoice for Extraction

http

POST /api/partner/extract-invoice
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

Body:
  file: [PDF or image file]
  store: true | false  (store in account)

Response

json

{
  "success": true,
  "documentId": "doc_abc123",
  "vendor": "Sysco Foods",
  "invoiceNumber": "INV-2026-00441",
  "invoiceDate": "2026-02-15",
  "dueDate": "2026-03-15",
  "lineItems": [
    {
      "description": "Chicken Breast 40lb Case",
      "quantity": 3,
      "unit": "CS",
      "unitPrice": 89.50,
      "lineTotal": 268.50
    }
  ],
  "subtotal": 268.50,
  "tax": 0.00,
  "total": 268.50,
  "fieldConfidences": {
    "vendor": 99,
    "invoiceNumber": 97,
    "invoiceDate": 98,
    "total": 99
  }
}

Submit Receipt for Extraction

http

POST /api/partner/extract-receipt
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

Body:
  file: [PDF or image file]
  store: true | false

Check Usage

http

GET /api/partner/usage
Authorization: Bearer YOUR_API_KEY

Rate Limits

Plan	Requests/minute	Requests/month
Starter	10	1,000
Professional	60	10,000
Enterprise	300	Unlimited

Error Codes

Code	Meaning
400	Invalid request — check file format and required fields
401	Invalid or missing API key
413	File too large — maximum 25MB
429	Rate limit exceeded
500	Processing error — retry with exponential backoff

Terms Summary

Troubleshooting