Skip to main content
Version: 1.0.0

GoRoute API

Peppol Document Exchange API​

A production-ready REST API for sending and receiving business documents over the Peppol network.

Features​

  • Send Documents: Queue UBL invoices and other documents for delivery via AS4
  • Track Transactions: Monitor delivery status with real-time updates
  • Webhooks: Receive notifications when documents are delivered or received
  • SMP Lookup: Query the Peppol network to verify trading partners
  • Multi-tenant: Secure API key authentication with per-organization isolation

Authentication​

All endpoints (except health checks) require authentication using an API key. Include the X-API-Key header in your requests:

X-API-Key: pk_live_your_api_key_here

Rate Limits​

Rate limits are per API key and enforced at two levels:

  • Per-minute limit (default: 60 requests)
  • Per-day limit (default: 10,000 requests)

Rate limit headers are included in all responses.

Idempotency​

For POST operations that create resources, include an Idempotency-Key header to prevent duplicate operations:

Idempotency-Key: your-unique-key

Keys expire after 24 hours.

Authentication​

API key for authentication

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key