Get Peppol eligibility

GET /api/v2/me/preferences/peppol

Read directory eligibility and saved opt-out. eligible=true and optedOut=false means Peppol is enabled for new invoices. reasonCode explains ineligibility; unknown must not be described as not registered. The stored identity verdict is informational; this read never verifies against a registry or changes delivery.

Account & Access Preferences

Authentication

Required API scope: read:account

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Peppol eligibility status.
eligible boolean · Example: true

True when the account can receive e-invoices through Peppol.

reason string · nullable · Example: null

Customer-facing reason when eligible is false.

orgNumber string · nullable · Example: 5561234567

Swedish organisation number used for lookup, normalized to 10 digits when possible.

peppolId string · nullable · Example: 0007:5561234567

participantName string · nullable · Example: Example AB

lookedUpAt string · nullable · Example: 2026-04-27T12:00:00.000Z

identity object

Stored company-identity verdict: does the account's company name match the Swedish company-register entry for the organisation number? mismatch means the number belongs to a different registered company and e-invoice delivery falls back to PDF email; unchecked means no verdict covers the current organisation number yet.

identity.status string · enum required · Example: match
match
mismatch
not_found
unknown
not_applicable
staff_confirmed
unchecked
identity.registryName string · nullable required · Example: Example Aktiebolag

The registered legal name the organisation number resolves to, when known.

identity.checkedAt string · nullable required · Example: 2026-04-27T11:59:58.000Z

Nullable: may be null when not applicable.

optedOut boolean

Saved opt-out for future invoices; independent of directory registration.

reasonCode string · nullable · enum

Why eligibility is false; unknown means lookup could not be completed.

unsupported_country
organisation_required
org_number_missing
not_registered
unknown
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/me/preferences/peppol
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/me/preferences/peppol" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "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"
}