Skip to main content

API reference

Three ways to explore the contract:

  1. Interactive playground → — Scalar against the public sandbox; run real calls from the browser.
  2. OpenAPI — download openapi.yaml or openapi.json and import it into Postman, Insomnia, or your SDK generator.
  3. Reference pages — cURL/Python guides per endpoint (below).

Endpoints

EndpointDescription
POST /v1/auth/tokenRefresh OAuth2 credentials.
POST /v1/invoicesIssue an e-CF (sandbox/staging/prod).
GET /v1/invoices/{docId}/statusCheck the status of a submission.
POST /v1/webhooks/testTrigger a test webhook to validate your endpoint.

Error codes follow RFC 9457. Every response includes type, which links to the dictionary.