An overview follows. The full reference — schemas, examples and a Try it button — lives in the interactive documentation.
standard
SAPI-SK
Eight endpoints of the standardised interface, interactive.
platformEnterprise API
Invoices, webhooks, notifications, credit and organisation management.
SAPI-SK standard
| Method | Endpoint | Description |
|---|---|---|
| POST | /sapi/auth/token | Issues an access token |
| POST | /sapi/auth/renew | Renews a token with the refresh_token |
| POST | /sapi/auth/revoke | Revokes a token |
| GET | /sapi/auth/token/status | Reports validity and whether a refresh is due |
| POST | /sapi/document/send | Sends a document into the Peppol network |
| GET | /sapi/document/receive | Lists inbound documents |
| GET | /sapi/document/receive/{id} | Returns the inbound document as JSON (XML in the payload) |
| POST | /sapi/document/receive/{id}/acknowledge | Acknowledges the document |
| GET | /sapi/health | Service health without authentication — same body as /health (200 / 503) |
Enterprise API
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/invoices | Creates and sends an invoice |
| GET | /api/v1/invoices | Lists invoices, cursor-paginated |
| GET | /api/v1/invoices/{id} | Invoice detail including status |
| GET | /api/v1/invoices/{id}/xml | The original UBL XML |
| GET | /api/v1/invoices/{id}/pdf | PDF rendering of the invoice |
| GET | /api/v1/invoices/search | Full-text invoice search, cursor-paginated; with scope=archive across archived invoices instead of current ones |
| DELETE | /api/v1/invoices/{id} | Cancels an invoice while still PENDING or VALIDATING |
| POST | /api/v1/documents/validate | Pre-flight validation of a document — no send, no credit |
| GET | /api/v1/participants/{peppolId}/reachability | Reports whether the receiver is in the network and supports the document type |
| POST | /api/v1/webhooks | Registers a webhook |
| POST | /api/v1/webhooks/{id}/test | Sends a test event |
| GET | /api/v1/billing/balance | Credit balance |
| POST | /api/v1/sapi-clients | Creates a SAPI client |
documents/validate and participants/{peppolId}/reachability cover the pre-flight
check: they validate the document and the receiver’s reachability, create no invoice and
consume no credit. The response shape, the meaning of reason and the limits are covered
in Pre-flight validation.