Person API

The Person API provides information on Norwegian citizens for the Norwegian public health sector. The API is maintained by Norsk helsenett.

Data in the API is compiled from multiple sources, with the primary source being the National Population Register ("Folkeregisteret"). The information model in the Person API is a superset of the National Population Register's information model. More information about the National Population Register's information model is available in Norwegian here: Folkeregisterets informasjonsmodell

See translations for a list of translations from norwegian terms used in the National Population Register to english terms used in the Person API.

Send feedback and questions to utvikling-persontjenesten@nhn.no

OpenAPI specification

See Person API

Versioning

See Versioning

Changelog

See Changelog

Synthetic test data

Data in our test environment is using synthetic test data coming from the Synthetic National Register. To browse the data available, you can log in using ID-porten at Testnorge

Authentication and authorization

This API uses HelseID for authentication and authorization. To use the API, you need a valid HelseID token with an appropriate scope. Version 3 uses DPoP for token exchange, while version 2 uses bearer tokens. You can request access to the Person API through the HelseID self-service portal.

In version 3 of the Person API, two scopes are available:

• FullAccess | Scope: nhn:hgd-persontjenesten-api/full-access

  Provides read access to all information, equivalent to the authorization bundle "public with legal basis" (statutory authority). Also includes access to confidential addresses.

• RestrictedAccess | Scope: nhn:hgd-persontjenesten-api/restricted-access

  Provides read access to all information except confidential addresses and CCR information.

  
  
  

Note: Version 2 of the Person API will be deprecated in 2025.
Version 2 uses these scopes to consume resources from the Person API:

• ReadWithLegalBasis | Scope: nhn:hgd-persontjenesten-api/read-with-legal-basis

  This scope provides read access to information in the authorization bundle "public with legal basis" (aka statutory authority).

  For version 0.5 name was nhn:hgd-persontjenesten-api/read

• ReadNoLegalBasis | Scope: nhn:hgd-persontjenesten-api/read-no-legal-basis

  This scope provides read access to information in the public bundle "public without legal basis".

Code samples

Code samples demonstrating an API client that exchanges a valid token from HelseID and makes requests to the Person API are available here:

• Java
• .NET Core

Disclaimer: These samples are provided for reference only and are not actively maintained. They should be used as inspiration rather than production-ready implementations.