Common steps to get Started with Altinn Correspondence

How to get started with Altinn 3 Correspondence, for service owners, senders and recipients

These are common steps that all roles (Service Owner, Senders and Recipients) need to complete in order to start using the Altinn Correspondence component.

1. Get an Altinn API Key

In order to use any Altinn APIs, you need a subscription key for the APIs. This is passed as the header Ocp-Apim-Subscription-Key in every request.

If you do not already possess an API Key for the Maskinporten Client(s) you intend to use against Correspondence, you can get it by contacting us at Altinn@Slack#produkt-melding.

2. Register your Maskinporten Client with correct scopes

Register your Maskinporten client(s) to authenticate with the Correspondence API, assigning them the relevant scopes for whether they will be used for sending and/or receiving messages:

• altinn:correspondence.write
• altinn:correspondence.read

These scopes are maintained by Altinn and are required to be authorized for the appropriate API operations, and as such are independent of the access set by Service Owners for the specific Correspondence Service Resource.

Use Samarbeidsportalen self-service for registration. Here’s a detailed guide.

• Test environments
• Production environment

3. Get access to specific resource

Contact the Service owner for the Correspondence Resource and ask for access to the Resource, supplying them with:

• Organization number you will represent
• System user

If you are a service owner creating your first Correspondence Service; skip to the Service Owner guide.

4. Integrate against Correspondence API

You are now ready to start integrating against the Correspondence APIs, see the developer guides for next steps.

5. Set up Event Subscriptions

In order to use events/webhooks for a Correspondence resource, you need to setup a subscription for the given resource.

See the developer guide for detailed instruction.