Organisation

The organisation represents a legal business entity which is uniquely identified by the combination of a legalIdentifierCode and a legalIdentifier. The legalIdentifierCode is the scheme id in the Peppol Participant Identifier Scheme, e.g. FR:SIRENE or SE:ORGNR.

Any authenticated user can create an organisation, by doing so the user automatically becomes a member in the organisation and gets the orgadmin role. With this role the user can then invite other users as members and admins to the organisation.

A newly created organisation starts in Demo mode (API enum: DEMO, also referred to as sandbox mode in the portal). In Demo mode:

The organisation can:

  • Create participants in Arratech's test SMP and send/receive transactions via Arratech's test access point.

The organisation cannot:

  • Upload certificates or create its own access points.
  • Use Arratech's production environment.

Mode changes are requested by setting modeChangeRequest to WHITELABEL or SHARED on a PUT /orgs/:orgId call. The organisation must have a BUSINESS contact assigned before the request is accepted (error AT-1120 otherwise). Superadmins approve by updating organisationMode; this automatically clears modeChangeRequest.

Endpoints

For information only. Full, normative endpoint definitions in the Swagger documentation.

EndpointDescriptionRole
POST /orgsCreate a new organisation.user
GET /orgs/:orgIdGet an organisationorgadmin
PUT /orgs/:orgIdUpdate an organisation. Use the modeChangeRequest field to request a mode change.orgadmin

Example Organisation datatype

{
  "type": "ORGANISATION",
  "id": "a33d7cda-c8f4-461c-b001-33ebd034144f",
  "legalName": "Acme Corporation Ltd.",
  "shortName": "Acme Corp",
  "countryCode": "SE",
  "legalIdentifier": "556123-4567",
  "legalIdentifierCode": "SE_ORGNR",
  "organisationMode": "WHITELABEL",
  "modeChangeRequest": null,
  "certificates": [
    {
      "name": "Acme Production Certificate",
      "type": "PRODUCTION",
      "id": "cert-12345-67890"
    },
    {
      "name": "Acme Test Certificate",
      "type": "TEST",
      "id": "cert-54321-09876"
    }
  ],
  "contacts": [
    {
      "name": "Anna Andersson",
      "email": "anna.andersson@acme-corp.se",
      "phone": "+46 8 123 45 67",
      "title": "IT Manager",
      "contactType": "TECHNICAL",
      "webContactUrl": "https://support.acme-corp.se",
      "annotation": "Primary technical contact for Peppol integration"
    },
    {
      "name": "Erik Eriksson",
      "email": "erik.eriksson@acme-corp.se",
      "phone": "+46 8 123 45 68",
      "title": "Business Development Manager",
      "contactType": "BUSINESS",
      "annotation": "Handles business inquiries and partnerships"
    }
  ],
  "businessAddress": {
    "streetAddress": "Storgatan 123",
    "city": "Stockholm",
    "country": "Sweden",
    "postalCode": "111 22"
  },
  "website": "https://www.acme-corp.se",
  "createdAt": "2025-07-02T12:13:45.011Z",
  "createdBy": {
    "userId": "7374a832-e041-7016-4482-e857ca1b5e36"
  },
  "lastModifiedAt": "2025-10-08T14:24:50.607Z",
  "lastModifiedBy": {
    "userId": "7374a832-e041-7016-4482-e857ca1b5e36"
  }
}