Get Peppol eligibility

GET /api/v2/me/preferences/peppol

Return Peppol e-invoice eligibility for the authenticated account. Eligible accounts are Swedish organisations whose organisation number is registered in the Peppol directory; ineligible responses include a customer-facing reason.

Account & Access Preferences

Authentication

Required API scope: read:account

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

Context

Related endpoints

PATCH /api/v2/me/preferences/peppol Update Peppol opt-out GET /api/v2/me/preferences Get account preferences PATCH /api/v2/me/preferences Update account preferences

Headers

Authorization Bearer <token>

Accept application/json

Responses

200 Peppol eligibility status. 6 fields

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

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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"
}

{
  "type": "object",
  "properties": {
    "eligible": {
      "type": "boolean",
      "description": "True when the account can receive e-invoices through Peppol."
    },
    "reason": {
      "type": "string",
      "description": "Customer-facing reason when `eligible` is false.",
      "nullable": true
    },
    "orgNumber": {
      "type": "string",
      "description": "Swedish organisation number used for lookup, normalized to 10 digits when possible.",
      "nullable": true
    },
    "peppolId": {
      "type": "string",
      "nullable": true
    },
    "participantName": {
      "type": "string",
      "nullable": true
    },
    "lookedUpAt": {
      "type": "string",
      "nullable": true
    }
  }
}