API Endpoints

API Endpoints and Required Header Parameters

Here are the main endpoints this API provides:

Participant Management

  • POST /elma/participants — Add a participant

  • PUT /elma/participants — Update participant info

  • GET /elma/participants — Get participant details

  • DELETE /elma/participants — Remove a participant

  • GET /elma/tenant/participants — List all tenant participants

Process Information

  • GET /elma/processes — List Peppol-supported processes

Document Handling

  • POST /elma/document/upload — Generate pre-signed upload URL

  • POST /elma/document/validate — Validate a Peppol document

  • POST /elma/document/send — Send a document through Peppol

  • GET /elma/document/status — Check delivery status

  • POST /elma/document/download — Generate download link for a document received

Notifications & Invoices

  • GET /elma/invoices/summary — Retrieve summary of invoices

  • GET /elma/invoices/pendingDownload — List invoices pending download

Authenticate Every Request

Each API request must include the following headers:

Header
Description

x-api-key

Your unique API key

tenantId

Your assigned tenant identifier

tenantSecret

Your tenant-specific secret token

language

Language code: en (English) or no (Norwegian)

Language Support

The language header determines the language of error messages and some localized content:

Value
Language

en

English

no

Norwegian

If an unsupported value is used, the API defaults to en.

Last updated