Peppol

Activate Peppol for the organization

Registers the organization as a participant in the Peppol network via the platform’s Access Point (legal entity + Peppol identifier are created under the platform account). Status may be pending when the Access Point requires an asynchronous verification (KYC). Provider and API key are platform configuration — they are never supplied by the customer.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
senderPeppolIdstringRequiredformat: "^\d{4}:.+$"
The organization's own Peppol address
legalNamestringRequired1-255 characters

Registered legal name — published in the Peppol directory

countrystringRequired=2 characters

ISO 3166-1 alpha-2

environmentenumOptionalDefaults to production

Peppol settings scope to use (which provider config + API key)

Allowed values:
addressobjectOptional

Postal address — some Access Points require it for KYC

Response

Registration state after the activation attempt
successboolean
settingsobject or null

Registration lifecycle state (null when nothing is configured)

errorCodestringOptional
errorMessagestringOptional

Errors

400
Register Peppol Request Bad Request Error
409
Register Peppol Request Conflict Error
501
Register Peppol Request Not Implemented Error
502
Register Peppol Request Bad Gateway Error