Enriched data in the Person API
Data in the Person API is mostly comes from the National Population Register (Folkeregisteret / FREG). However, some information is enriched from other sources, and this page will provide an overview of these.
Common contact register information
The Person API enriches responses with data from the Common contact register (Kontakt- og reservasjonsregisteret / KRR), if the person has information in this registry. The information includes his preferred language of communication, telephone number, e-mail address and digital postbox that can be used for for electronic communication, or if the person has opted out of electronic communication.
The Person API imports data from the Common contact register continuously, and also sends a ChangeInCommonContactRegisterInformation event if the information on a person has changed.
Below you can see a JSON example of data from the common contact register in a response from the Person API:
Json example
"commonContactRegisterInformation": {
"reservation": "Yes",
"status": "Active",
"notificationStatus": "CanNotBeNotified",
"contactInformation": {
"email": "01012295312_test@minid.difi.no",
"emailLastUpdated": "2016-08-05T10:45:15.768Z",
"emailLastVerified": "2022-08-05T10:45:15.768Z",
"phoneNumber": "123456789",
"phoneNumberLastUpdated": "2016-08-05T10:45:15.768Z",
"phoneNumberLastVerified": "2022-08-05T10:45:15.768Z"
},
"digitalPost": {
"digitalPostAddress": "ola.nordmann#9YDT",
"digitalPostVendorAddress": "984661185, 922020175"
},
"certificate": "X509Certificate",
"language": "nb",
"languageLastUpdated": "2022-08-05T10:45:15.768Z"
}
Address enrichment
Additional municipality and county information
For residential, present and shared residence addresses, in addition to information on marital status and birth, FREG provides only the municipality number (kommunenummer). On these information parts, the Person API includes some additional data points, resulting in the following data on municipalities and counties:
Data point | Source | Data type | Example | Description |
---|---|---|---|---|
MunicipalityNumber (kommunenummer) | FREG | String | 5503 | Four digit code identifying the municipality |
MunicipalityName (kommunenavn) | Person API (SSB) | String | Harstad - Hárstták | The municipality name. Some municipalities also include names in Sámi languages |
CountyNumber (fylkesnummer) | Person API (SSB) | String | 55 | Two digit code identifying a county |
CountyName (fylkesnavn) | Person API (SSB) | String | Troms - Romsa - Tromssa | The name of the county. Some counties also include names in Sámi languages |
The Person API uses the following classifications from Statistisk Sentralbyrå (SSB) to include this information:
These two classifications are combined into a single dataset that links all municipalities to counties in Norway. Even though changes to municipalities and counties are rare, this dataset is updated every day in the Person API. The dataset valid from 2024 can be downloaded using this URL:
or can be printed in json by running the following curl command:
curl -X "GET" "https://data.ssb.no/api/klass/v1/classifications/131/correspondsAt?date=2024-01-01&targetClassificationId=104" -H "Accept: application/json"
Below you can see a JSON example of municipality and county information included in information on marital status.
Json example
"maritalStatus": [
{
"status": "Married",
"statusDate": "1991-02-09T00:00:00Z",
"authority": "DEN_NORSKE_KIRKE",
"municipalityNumber": "0301",
"municipalityName": "Oslo",
"countyNumber": "03",
"countyName": "Oslo",
"place": "Sist Testkirke",
"abroad": null,
"relatedByMaritalStatus": "13926298253",
"registeredAt": "2022-03-11T15:35:30.143022Z",
"isValid": true,
"source": "Synutopia",
"reason": "Patch",
"validFrom": "1991-02-09T15:35:30.143021Z",
"validTo": null
}
]
Basic statistical units (grunnkrets) and urban districts (bydel)
Below is a quick overview over addresses that include basic statistical units and urban districts:
Address type | Guaranteed basic statistical unit | Basic statistical unit sources | Guaranteed urban district for address in city |
---|---|---|---|
Residential address | Yes | FREG (BasicStatisticalUnit) Person API (FullBasicStatisticalUnitNumber) |
Yes |
Present address | No | Person API (FullBasicStatisticalUnitNumber) | No |
Shared residence | No | Person API (FullBasicStatisticalUnitNumber) | No |
Below you can see a JSON example of a residential address with basic statistical units and urban districts included, in addition to municipality and county information.
Json example
"residentialAddress": [
{
"streetAddress": {
"separatelyOccupiedUnitNumber": "H0101",
"separatelyOccupiedUnitType": "Housing",
"addressName": "KONGENS GATE",
"addressNumber": {
"houseNumber": "120",
"houseLetter": "A"
},
"addressCode": "01100",
"addressAdditionalName": null,
"city": {
"cityName": "TRONDHEIM",
"postalCode": "7022"
},
"coAddressName": null,
"municipalityNumber": "5001",
"municipalityName": "Trondheim - Tråante",
"countyNumber": "50",
"countyName": "Trøndelag - Trööndelage"
},
"cadastralAddress": null,
"unknownResidence": null,
"cadastralIdentifier": "6344200241",
"closeCadastralIdentifier": null,
"addressConfidentiality": "Unclassified",
"moveDate": "2019-03-18T00:00:00Z",
"basicStatisticalUnit": 5218,
"fullBasicStatisticalUnitNumber": "50015218",
"basicStatisticalUnitName": "MUNKVOLD",
"constituency": 22,
"schoolDistrict": 5153,
"churchDistrict": 1,
"urbanDistrictCode": "500101",
"urbanDistrictName": "Midtbyen",
"geographicalUrbanDistrictCode": "500101",
"geographicalUrbanDistrictName": "Midtbyen",
"registeredAt": "2020-03-31T18:41:15Z",
"isValid": true,
"source": "KILDE_DSF",
"reason": "Endring av postnummer, skole-, valg- og grunnkrets",
"validFrom": "2019-03-17T23:00:00Z",
"validTo": null
}
]
Basic statistical units (grunnkrets)
In FREG, only the residential address is guaranteed to be a real address in Norway which exists the Norwegian property register (Matrikkelen), and is the only address where FREG includes a basic statistical unit.
For present and shared residence addresses, the Person API attempts to include a basic statistical unit by looking up the address in the Norwegian property register dataset, but there is no guarantee that there will be a match, and we're able to provide this data.
Basic statistical units for addresses are provided in the following datapoints for residential, present and shared residence addresses:
Data point | Source | Data type | Example | Provided for addresses | Description |
---|---|---|---|---|---|
BasicStatisticalUnit | FREG | Integer | 5218 | Residential address | 3-4 digit code identifying the statistical unit within a municipality |
FullBasicStatisticalUnitNumber | Person API (SSB) | String | 50015218 | Residential address Present address Shared residence addresses |
8 digit code uniquely identifying the statistical unit in Norway. First 4 digits are the municipality number. |
BasicStatisticalUnitName | Person API (SSB) | String | MUNKVOLD | Residential address Present address Shared residence addresses |
The name of the basic statistical unit |
Urban districts (bydel)
For residential, present and shared residence addresses, the Person API also includes data for geographical and service providing urban districts. Urban districts are mapped from basic statistical units, so only residential addresses are guaranteed to have this information if the person lives in a city which have urban districts, namely Oslo, Bergen, Stavanger and Trondheim.
Data on urban districts are provided in the following data points:
Data point | Defined by | Data type | Example | Description |
---|---|---|---|---|
UrbanDistrictCode | City/municipality | String | 030105 | Six digit code identifying the urban district that provide municipal social and healthcare services for the address |
UrbanDistrictName | City/municipality | String | Frogner | Service providing urban district name |
GeographicalUrbanDistrictCode | SSB | String | 500101 | Six digit code identifying the geographical urban district for the address |
GeographicalUrbanDistrictName | SSB | String | Midtbyen | Geographical urban district name |
Service providing urban districts
Service providing urban districts are defined by the city, but only for Oslo there is a difference in geographical and service providing urban districts. The differences (at the time of writing) is that the geographical urban districts Marka and Sentrum are not service providing urban districts, and people living in these districts get municipal social and healthcare services from other districts.
For Oslo, the mapping from basic statistical units to service providing urban districts are updated manually based on data provided from Plan- og bygningsetaten in Oslo kommune.
Geographical urban districts
Geographical urban districts are defined by Statistisk Sentralbyrå (SSB). The Person API uses the following classifications from SSB to provide information on geographical urban districts:
These two classifications are combined into a single dataset that links all statistical units to urban districts in Norway. This dataset is updated every day in the Person API. The dataset valid from 2024 can be downloaded using this URL:
or can be printed in json by running the following curl command:
curl -X "GET" "https://data.ssb.no/api/klass/v1/classifications/1/correspondsAt?date=2023-01-01&targetClassificationId=103&includeFuture=true" -H "Accept: application/json"