Participants

When someone (typically a company) is registered in the Peppol network in order to receive business documents they become a participant in Peppol nomenclature.

In Arratech Solution, a participant always lives in the scope of an organisation, meaning that the organisation owns and manages one or more participants. When a participant is created, it is automatically registered in the Peppol SML. If you also want the participant to show up in the Peppol Directory you register this in a separate API call.

Peppol SML

The Peppol SML is the central Peppol service that serves as the DNS/address registry for all document transactions. When registered in the SML, a participant can be discovered by others and receive documents. Note that the test equivalent of the SML is called SMK, where all participants associated with test certificates are listed.

Peppol Directory

The Peppol Directory is a non mandatory registration service where participants are registered with additional, richer metadata than in the SML. This directory allows for more flexible search patterns than the SML, for example it is possible to search for participants via name. Participants in the Arratech solution are published in the Peppol Directory via the ../participants/request-pd-publish endpoint.

Create a Participant

To create a participant you need a valid Peppol participant id scheme value. These identifiers are generally country specific and based on the ISO 6523 scheme.

Typically a participant will use its company registration number as the Peppol id. An example of a Swedish identifier is: 0007:2120000787.

In addition to the participant identifier you must provide a name, an access point and a SMP when you create the participant. Depending on the mode the organisation is running in (shared or whitelabeled), the access point to use can be an Arratech access point or the organisation's own access point. Available access points for each organisation are given via the ../aps/alltouse endpoint.

For SMP, the only available choice right now us to use the Arratech hosted SMP.

Besides the data required to create a participant, a set of optional metadata, grouped as a Business Card entity, can be appended. This data gives more information and enriches lookup/search results for the participant.

Supported Documents

As described above, the business card contains metadata for the participant, and the access point defines the URL to which documents aimed for the participant are to be sent. One last piece of key information is which document types the participant is able to receive.

Supported document types are added to the participant after it has been created, via the /orgs/:id/participants/:id/supported_document_types endpoint. To facilitate the search for available document types, the API contains a /document_types endpoint.

Peppol Participants in Arratech

Looking up a Peppol participant

Use GET /lookup to check whether a participant is registered in the Peppol network and retrieve their routing details. This endpoint searches both the Peppol public registries (SML/SMK and Peppol Directory) and Arratech's own registry.

Parameters

  • participantIdentifier (required) — the Peppol participant identifier in scheme:value format, e.g. 0007:6391770653567760
  • environment (optional) — PROD or TEST, defaults to PROD

Response

  • name — the registered participant name
  • participantIdentifier — the identifier you searched
  • accessPoints[] — each with apUrl, transportProfile, certificateSubject, certificateExpiry, and supportedDocuments (list of document type URNs)

Note: in Arratech's solution each participant connects to one access point, but results from other Peppol providers may include multiple access points.

Lowest role: public (no authentication required)

KYC and Local Registrar (coming soon)

Two extensions to the Participants feature are in development:

  • KYC (Know Your Customer) — attach and manage KYC documents per participant, including document upload and download.
  • Local Registrar — jurisdiction-specific registration data, including French Annuaire integration for FR participants.

These are not yet available. They will appear in the API Reference when released.