Skip to main content

Onboarding Flow

Complete end-to-end flow to onboard a new end customer and send their first invoice.

Step-by-step flow​

1. POST /auth/login                                    (partnerApiKey)   → partner JWT
2. POST /white-label-partner/create-user               (partner JWT)     → userId
3. POST /white-label-partner/create-company            (partner JWT)     → companyId + companyApiKey
4. POST /white-label-partner/register-request          (partner JWT)     → status
5. GET  /white-label-partner/companies/{id}/status     (partner JWT)     → poll until ACTIVE
6. POST /auth/login                                    (companyApiKey)   → company JWT
7. POST /invoice/send-document-async-json              (company JWT)     → trackingId
8. GET  /invoice/document-status/{trackingId}          (company JWT)     → COMPLETED

Detailed steps​

Step 1 — Partner login​

Call Authentication with your partner apiKey to obtain a partner JWT.

Step 2 — Create user​

Call Create user with the partner JWT to register the end-customer user.

Step 3 — Create company​

Call Create company with the partner JWT. You receive a companyId and companyApiKey.

Step 4 — Register on Peppol​

Call Submit register request with the partner JWT and the company's companyApiKey.

With participantAutoApprove enabled, status returns APPROVED immediately.

Step 5 — Verify registration​

Poll Company status until peppolStatus is ACTIVE.

Step 6 — Company login​

Call Authentication with the companyApiKey to obtain a company JWT.

Step 7 — Send invoice​

Call Send invoice with the company JWT. You receive a trackingId.

Step 8 — Check delivery​

Poll Document status with the trackingId until status is COMPLETED.