Users, Members and Organisations
Users
An individual who signs up to the Arratech Solution becomes a registered user. Users are uniquely identified by their verified email address, and we may opt for collecting additional user information during the onboarding process.
By default, a newly registered user is assigned the user role, with restricted access to API functionality.
Members
A user can be a member of one or more organisations. Each membership has a Member role. Member roles are 'orgadmin' and 'orgmember'. A user who is a member of an organisation can perform API operations in the scope of this organisation, such as Access Point and SMP operations.
Any user can create a new organisation - the user automatically gets a membership and becomes administrator (orgadmin) for that organisation. A user can also be granted a membership in an existing organisation via an existing administrator.
Organisations
An organisation is the top level structure for many of the API entities within Arratech Solution. It represents the entity that has a legal agreement with Arratech and contains one or more users (via memberships, as described above) who act on behalf of the organisation.
Organisation Modes
Every new organisation starts in Demo mode (API enum: DEMO, also called sandbox mode in the portal). In Demo mode, certificate creation is disabled and participant numbers are limited. Via a request to Arratech, an org admin can request promotion to either Shared mode or Whitelabel mode.
| Display name | API enum value | Description |
|---|---|---|
| Demo mode (sandbox) | DEMO | Default for all new organisations. Restricted: no certificates, limited participants. |
| Shared mode | SHARED | Production mode using Arratech's shared Peppol infrastructure. |
| Whitelabel mode | WHITELABEL | Production mode for organisations with their own Access Point. |
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, create its own access points or use Arratech's production environment.
Whitelabel mode
The organisation can upload its own access point certificate and create and manage its own, whitelabeled, access point(s). It can use Arratech's test and production SMPs for registering participants.
The organisation cannot use Arratech's production access point.
Shared mode
The organisation can use Arratech's production access point together with Arratech's production SMP and therefore does not need to own and manage its own Peppol certificates.
The organisation can also do everything a whitelabeled organisation can do.
Requesting a Mode Change
An org admin can request promotion from Demo to Shared or Whitelabel mode by setting the modeChangeRequest field to WHITELABEL or SHARED on a PUT /orgs/:orgId call.
Prerequisite: the organisation must have a contact of contactType: BUSINESS assigned in its contacts array. Without this, the API returns error AT-1120.
An Arratech superadmin approves the request by updating organisationMode directly. This automatically clears modeChangeRequest. To reject, the superadmin sets modeChangeRequest to null.
Valid transitions: Demo → Shared or Whitelabel; Whitelabel → Shared; Shared cannot request further changes.
- Contact Arratech
- Use the Change Mode button in the Arratech Connect portal (in the Organisation Settings view).
- Make an Update Organisation API call to set the
modeChangeRequestproperty.
Arratech Solution: Users, Members, Organisations & Modes
Users
- A person who signs up becomes a registered user.
- Uniquely identified by verified email address.
- Additional info may be collected during onboarding.
- Default role:
user(restricted API access).