Skip to content

Get Peppol eligibility

GET /api/v2/me/preferences/peppol

Checks whether your company can receive invoices as Peppol e-invoices. It also shows whether you have opted out. Peppol needs a Swedish company account with an organisation number that is registered in the Peppol directory for invoices. New invoices go out through Peppol when eligible is true and optedOut is false. When eligible is false, reason says why in plain English and reasonCode gives it as a code: unsupported_country, organisation_required, org_number_missing, not_registered, not_registered_for_invoices or unknown. not_registered_for_invoices means the company is in the directory but does not receive invoices there. unknown means the directory could not be checked right now. A successful directory answer is reused for up to an hour. identity shows the last saved check of the company name against the company register. This call does not run a new check. To opt out, use PATCH /api/v2/me/preferences/peppol.

Authentication: An API key with the scope read:account. About keys and scopes

Example

GET /api/v2/me/preferences/peppol
curl "https://cloud.hostup.se/api/v2/me/preferences/peppol" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The Peppol status of the account.

Response 200
{
"eligible": false,
"reason": "Your organisation is not registered in the Peppol directory yet.",
"orgNumber": "5561234567",
"peppolId": null,
"participantName": null,
"lookedUpAt": "2026-04-27T12:00:00.000Z",
"identity": {
"status": "match",
"registryName": "Example Aktiebolag",
"checkedAt": "2026-04-27T11:59:58.000Z"
},
"optedOut": false,
"reasonCode": "not_registered"
}
Response fields
eligibleboolean
True when the account can receive e-invoices through Peppol.
reasonstring or null
Why eligible is false, ready to show.
orgNumberstring or null
The Swedish organisation number used for the lookup, as 10 digits when possible.
peppolIdstring or null
participantNamestring or null
lookedUpAtstring or null
identityobject
Whether the company name on the account matches the Swedish company register for the organisation number. mismatch: the number belongs to another registered company. Invoices then go out as PDF by e-mail instead of as e-invoices. unchecked: the current organisation number has not been checked yet.
statusstring
One of match, mismatch, not_found, unknown, not_applicable, staff_confirmed, unchecked.
registryNamestring or null
The registered company name for the organisation number, when known.
checkedAtstring or null
optedOutboolean
The saved opt-out for future invoices. It does not depend on the registration in the Peppol directory.
reasonCodestring or null
Why eligible is false. unknown means the lookup could not finish. One of unsupported_country, organisation_required, org_number_missing, not_registered, unknown.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.