These pages contain detailed technical information about the Altinn Service Owner API. All operations and parameters are described and example responses are given. Further information regarding authentication, usage and license requirements is available at Altinn docs. Information and source code for the Altinn Reference App can also be found there.

Access and use

An API-key is required in order to use the Altinn API. (For information on obtaining an API-key see Altinn docs). The API-key needs to be included as a header value in every request. The API-key must be authorized to access service owner resources. For any additional questions regarding the API-key see Altinn docs.

The service owner API also requires an enterprise certificate issued by Commfides or Bypass. All requests must have a query parameter with the name ForceEIAuthentication and contain the certificate. The certificate must be issued to the same organization number as the service owner registered in Altinn.

Sample request

GET https://www.altinn.no/api/serviceowner/organizations?ForceEIAuthentication HTTP/1.1
Host: www.altinn.no
Accept: application/hal+json
ApiKey: myKey

Supported content types

The recommended content types for the Altinn API are application/hal+json or application/hal+xml. The hal content types describes how a client can interact with the available services. When retrieving for instance a Message, this will contain links to available actions for the given object. See the HAL specification for more information about how this is implemented in the Altinn API.

Note: The Altinn API currently also support the content types application/json and application/xml. The support for these content types will be removed in a future release, so it is recommended to use application/hal+json or application/hal+xml.

Models

+ Organization

Name Type Description
Name String The organization name from the register of legal entities.
OrganizationNumber String The organization number.
Type String The organization type. This is a code from the register of legal entities.
LastChanged DateTime The date and time for when some data on the organization was changed.
LastConfirmed DateTime The date and time for the last time the data on the organiation was confirmed. This date is only set if a user confirms the data on a special confirmation page in the portal. The page comes visible automatically if the LastChanged value is of a set age. (Data is considered confirmed as long as it is kept up to date.)
OfficialContacts A list of official contacts. This list is not populated unless it is explicitly requested with the OData $expand parameter. $expand=OfficialContacts (case sensitive).

+ OfficialContact

Name Type Description
MobileNumber String The registered mobile phone number on this contact point.
MobileNumberChanged DateTime The date and time for when the mobile phone number was added or changed.
EMailAddress String The registered email address on this contact point.
EMailAddressChanged DateTime The date and time for when the email address was added or changed.

+ PersonalContact

Name Type Description
PersonalContactId String A unique id representing the contact in Altinn.
Name String The name of this contact.
SocialSecurityNumber String The social security number of this contact.
MobileNumber String The registered mobile phone number on this contact point.
MobileNumberChanged DateTime The date and time for when the mobile phone number was added or changed.
EMailAddress String The registered email address on this contact point.
EMailAddressChanged DateTime The date and time for when the email address was added or changed.

+ Reportee

Name Type Description
Name String The name of the reportee.
Type String The type of reportee. Value depends on the language choice of the user.
English: Enterprise | Business | Person
Bokmål: Foretak | Bedrift | Person
Nynorsk: Føretak | Bedrift | Person
Status String Indicates whether the organization is active or inactive. An organization can be inactive if it for some reason (e.g. bankruptcy) has ceased. This is populated only if the reportee is an organization.
OrganizationNumber String The organization number of the reportee. This is populated only if the reportee is an organization.
ParentOrganizationNumber String The parent organization number of the reportee. This is populated only if the reportee is an organization, and the organization is a suborganization.
TypeOfOrganization String The type of organization for the reportee. This is populated only if the reportee is an organization. E.g ENK, AS, ORGL.
SocialSecurityNumber String The social security number of the reportee. This is populated only if the reportee is a person.

+ Right

Name Type Description
RightID Int A unique id for the specific right.
RightType String Specifies the type of right. Possible values are Message, Service and SystemResource.
SystemResourceID String Id of the system resource. Visible only for a right of type SystemResource.
ServiceCode String Part 1/2 of the id of a specific service. Visible only for a right of type Service.
ServiceEditionCode int Part 2/2 of the id of a specific service. Visible only for a right of type Service.
MessageID int Value used to identify a specific message.
Action String Action supported by the right. Possible values are Read, Write, Sign, ArchiveRead and ArchiveDelete.
RightSourceType String Specifies the way the right is given. Possible values are PartyRights, RoleTypeRights, ReporteeElementRights and DirectlyDelegatedRights.

+ Role

Name Type Description
RoleType String Specifies the type of role this is. Possible values are Altinn, External and Local.
RoleDefinitionId int Unique id of the role definition.
RoleName String Name of the role.
RoleDescription String Description of the role.
RoleDefinitionCode String The short hand code for the role.

+ RoleDefinition

Name Type Description
RoleType String Specifies the type of role this is. Possible values are Altinn, External and Local. Can be left out when creating a new role. Value will be set to Local.
RoleDefinitionId Int Unique id of the role definition.
RoleName String A descriptive name for the role.
RoleDescription String A complementary description of the role.
RoleDefinitionCode String The short hand code for the role.

+ Event

Name Type Description
EventId int Unique identifier for the event
EventType String Specifies the type of the event. Possible values are CorrespondenceCreated, CorrespondenceRead, CorrespondenceConfirmed, CorrespondenceArchived, CorrespondenceDeleted, CorrespondenceReserved, CorrespondenceNotificationCreated and CorrespondenceNotificationSent
EventTime DateTime Timestamp for when the event occured
EventDetails Dictionary A list of Key Value pairs representing the detail information for the event

+ SrrRight

Name Type Description
Id Int? A unique identifier for the SrrRight. This is given to all new and changed rights when using POST and PUT operations.
ServiceCode String The service code of the associated service. Together with ServiceEditionCode it uniquely identifies a service.
ServiceEditionCode String The service edition code of the associated service. Together with ServiceCode it uniquely identifies a service.
Reportee String The id of the legal entity that this right is given to. Valid values must be a social security number or organization number.
Operation String Defines which operation that the right covers. Valid values are Read and Write.
ValidTo DateTime Specify when a right will expire and the right is effectively lost.
Condition SrrRightCondition Entity containing the condition information. This involves a complex set of rules that will vary from service to service.
OperationStatus String Feedback field used in a response after a POST or PUT request.

+ SrrRightCondition

Name Type Description
HandledBy String The organization number of an organization that has been given the right to act on the behalf of the reportee as a third party. Used by consent.
IsRecipient Boolean Flag to indicate whether the reportee is a recipient of a service payload. Can be set to true on Write rights. Used during authorization by broker service to determine who the reportee can send payloads to. If the value is true, the reportee can only send payloads as a response to a separate service instance.
IsSender Boolean Flag to indicate whether the reportee is a sender of a service payload. Can be set to true on Read rights. Used during authorization by broker service in combination with the IsRecipient flag to determine who the reportee can send payloads to. A value of true means the reportee is marked as an organization that can start an exchange of payloads. Organizations that has a Write right with the IsRecipient equal true can send payloads only to organizations marked in this way.
KeepSessionAlive Boolean Flag to indicate whether the user should be signed out of Altinn again after visiting the consent page. If a consent involves multiple rights it is enough with one right having this flag set to true and the user will remain signed in.
AllowedRedirectDomain List of String List of domains that the consent page is allowed to redirect a user to after having visited the consent page.
Name Type Description
AuthorizationCode String The GUID for the authorization token for the consent.
Status String The status of the consent. It can be Active or Revoked.
OfferedBy Reportee The person or organization that has given a consent to CoveredBy.
CoveredBy Reportee The person or organization that can act upon the consent.
HandledBy Reportee (Optional) The person or organization that can act on behalf of CoveredBy.
Created DateTime The date and time for when the consent was initially processed by OfferedBy.
ValidTo DateTime The date and time for when the consent is no longer valid. Once it is no longer valid the consent cannot be acted on by CoveredBy or HandledBy.
LastChanged DateTime The date and time for when the status of the consent was last changed. If this is different from Created, it means that the Status has gone from Active to Revoked.

+ DelegationRequest

Name Type Description
RequestStatus String The status of the delegation request. (Only in response)
CoveredBy Reportee The person or organization that requests the rights.
OfferedBy Reportee The person or organization that can approve or decline the requested rights.
Created DateTime The date and time for when the request was initially created. (Only in response)
LastChanged DateTime The date and time for when the request was last changed. (Only in response)
RedirectUrl Uri The url where the user should be redirected to when the request has been submitted by the user. (Optional)
KeepSessionAlive Boolean A value indicating whether the session in altinn should be kept alive after the redirect. Can only be used in combination with RedirectUrl. (Optional)
RequestMessage String A message explaining why CoveredBy should get the rights specified in the request. This is to help the RoleAdministrator in OfferedBy to understand why this request is made. This is a draft of the message, and CoveredBy will be able to change the message before sending it to the RoleAdministrator. (Optional)
RequestResources List<DelegationRequestResource> Array containing the Requested Services

+ DelegationRequestResource

Name Type Description
ServiceCode String The external service code of the related service.
ServiceEditionCode Integer The external service edition code of the related service.
Operations List<OperationType> Array of operations.

Actions

+ Organizations

+ Reportees

+ Rights

+ Roles

+ RoleDefinitions

+ Events

+ SrrRight

+ Consents

+ DelegationRequests

+ Notifications

OData filtering

OData can be used to enable filtering, paging and ordering of lists of elements returned by most methods returning a list. The filter option of OData makes it possible to filter the result based on the properties of the model returned. For example by applying the following parameter when requesting organizations that are sole proprietorship. $filter=Type eq 'ENK'.

The OData options (with some limits) supported so far are:

For more information about OData see OData.