Clean JSON. Signed webhooks. No ceremony.
Every endpoint documented below is live on api.nexosscan.com. Full OpenAPI 3.1 spec also available for client generation.
Authentication
All endpoints require an API key in the X-API-Key header. Keys are issued per partner from the admin dashboard and scoped to specific capabilities (extraction, storage, webhooks).
curl -X POST https://api.nexosscan.com/api/v1/partner/invoices/upload \
-H "X-API-Key: pnr_live_..." \
-F "file=@invoice.pdf" \
-F "storeId=3fa2b9a1-..."Partner tiers
Extraction API
- •NexosIQ extraction
- •CostIQ categorization
Extraction + Storage
- •Everything above
- •Cloud document storage
- •NexosIQ Search across archive
- •Webhooks
Platform Embed
- •Full white-label
- •Sub-tenant provisioning
- •Single Sign-On
- •Deep-link embedding
Adapter (per-partner shape)
Run extraction on a document you already have in S3 and get the result in YOUR existing JSON schema — defined per partner via a small configuration profile. Built for enterprise integrations where you can't refactor downstream pipelines to match a new vendor's shape.
/api/v1/partner/extractExtract a document, return it in YOUR JSON shape
Pulls a document from your S3 bucket, runs NexosIQ extraction, applies your per-partner shape profile, and returns the result. Two ways to pass the source: send a pre-signed HTTPS S3 URL via `source_url` (recommended — you keep full control, no cross-account IAM required), OR an `s3://bucket/key` URI if your bucket is configured to grant Nexos read access. Pass a `correlation_id` for 24-hour idempotency (retries return the cached result with cache_hit: true). Response shape governed by your profile — ask your account team for the spec.
Invoices
Upload documents for NexosIQ extraction with 99% accuracy.
/api/v1/partner/invoices/uploadUpload an invoice
Submit a PDF, JPG, PNG, or WEBP for NexosIQ extraction. Returns structured data within 60 seconds. Multi-page and multi-vendor PDFs handled automatically.
/api/v1/partner/invoices/{id}Get an extracted invoice
Retrieve a previously extracted invoice by UUID. Includes line items with CostIQ category assignments.
Receipts
Upload receipts for NexosIQ extraction with automatic CostIQ categorization.
/api/v1/partner/receipts/uploadUpload a receipt
Submit a receipt image. Returns structured data with per-line-item CostIQ tax category (Meals, Supplies, Travel, etc.) + payment method detection.
Search
NexosIQ Search — semantic search across all indexed tenant documents.
/api/v1/partner/search?q={query}&type={type}&limit={n}Semantic search
Search by meaning, not keywords. Returns invoices, receipts, or vendors ranked by 512-dimension vector similarity. Type filter: invoice | receipt | vendor.
Vendors
Vendor management and price tracking.
/api/v1/partner/vendorsList vendors
Paginated list of vendors with invoice count and total spend. Supports limit + offset.
Webhooks
Register HTTPS endpoints for real-time event delivery with cryptographically signed payloads.
/api/v1/partner/webhooksRegister webhook
Subscribe to events: invoice.created, invoice.processed, invoice.failed, receipt.processed, vendor.created. Secret returned once at registration — store it for signature verification.
Tenants
Platform Embed tier — manage sub-tenants under your partner account.
/api/v1/partner/tenantsCreate a sub-tenant
Provision a new NEXOS tenant under your partner account. Returns a setup URL that can be deep-linked into your product for the tenant to complete onboarding with optional Single Sign-On.
Ready to integrate?
Request an API key and start posting documents within the hour. Full OpenAPI spec imports cleanly into Postman, Insomnia, and most client generators.