Supplier / Partner API

The Nuntiq Partner API is the integration surface for partner / supplier systems that need to push invoices into a Nuntiq customer's tenant on their own behalf. It is the API behind every "Send to Nuntiq" button in a supplier billing system, every automated invoice export, and every e-invoicing gateway connector that fronts for a real supplier.

It is intentionally narrow. The partner surface exposes invoice submission and key self-management, and nothing else.

If you need richer integration (master data, lifecycle polling, claiming invoices for ERP push) you want the Customer API or the Connector Framework instead, both of which use customer-issued credentials rather than per-partner ones.

Two surfaces, one API

The Partner API is split into two surfaces, both rooted at /v1/partner:

Surface	Auth	Used by
Partner API	X-API-Key (your key)	Your backend, invoice submission + key mgmt
Supplier Access	Public (token in URL/body)	The supplier-portal pages your users click into

The Partner API is what your integration calls server to server. Every request takes an X-API-Key header carrying the key the customer issued you.

The Supplier Access endpoints are the public flow that backs the supplier portal pages your users visit when they claim a key from an email invitation, generate a replacement, or manage which reminder emails they receive. You normally do not call those endpoints directly, your users do, by clicking links in emails.

How partners get a key

A customer onboards you by creating a "partner account" in their Nuntiq admin or customer portal and adding one or more notification email addresses. Triggering the invitation sends a one-time magic link to those addresses. The recipient lands on the customer's supplier portal, requests a 6-digit code, enters it, picks an expiration interval, and the portal issues an api_key plus a rotation_secret. Both are shown exactly once.

There is no admin-portal "see this key in plaintext" path. The key is born on the supplier portal, in the recipient's browser, full stop. If you lose it, you generate a new one through the same flow, the old one stays usable for a 4-hour grace window while you swap it out.

See Key lifecycle for the full mechanics.

What's in this section

• Getting started: your first call, end to end.
• Authentication: X-API-Key, X-Rotation-Secret, what fails how.
• Environments: dev / test / prod base URLs and path layout.
• Keys: claim, rotate, expire, regenerate, the 4-hour grace window, the helpful key_expired response.
• Submitting invoices: request shape, base64 attachments, Idempotency-Key, the receiving_inbox fallback, warnings.
• Email preferences: which reminder emails your recipients receive, and how they manage that.
• API Reference: every endpoint, generated from the live OpenAPI spec. Partner API + Supplier Access in one place.

:::tip Spec is the source of truth The reference under API Reference is regenerated from the live swagger definitions in nuntiq-customer-api. If a field on this page disagrees with the reference, the reference wins. :::