Berikede data i Person‑API
Data i Person‑API kommer i hovedsak fra Folkeregisteret (FREG). Noen opplysninger blir imidlertid beriket med data fra andre kilder – denne siden gir en oversikt over slike berikelser.
Felles kontaktregister (KRR)
Person‑API beriker svarene med informasjon fra Felles kontaktregister (KRR) når personen har data i dette registeret.
KRR‑informasjonen inneholder:
- Foretrukket språk for kommunikasjon
- Telefonnummer
- E‑postadresse
- Digital postkasse som kan benyttes for elektronisk kommunikasjon, eller informasjon om at personen har opt‑out fra digital kommunikasjon.
Person‑API importerer KRR‑data fortløpende, og sender også en ChangeInCommonContactRegisterInformation‑hendelse dersom KRR‑informasjonen for en person endres.
Nedenfor vises et JSON‑eksempel på KRR‑data i et svar fra Person‑API:
Json eksempel
"commonContactRegisterInformation": {
"reservation": "Yes",
"status": "Active",
"reservationTime" : "2016-08-05T10:45:15.768Z",
"reservationUpdated": "2022-08-05T10:45:15.768Z",
"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"
}
Adresse‑berikelse
Tilleggsinformasjon om kommune og fylke
For bosteds‑, oppholds‑ og delt‑bosteds‑ adresser, samt opplysninger om sivilstatus og fødsel, gir Folkeregisteret (FREG) kun kommunenummer (kommunenummer). Person‑API beriker disse elementene med flere datapunkter, slik at du får følgende informasjon om kommuner og fylker:
| Datapunkt | Kilde | Datatype | Eksempel | Beskrivelse |
|---|---|---|---|---|
MunicipalityNumber (kommunenummer) |
FREG | String | 5503 |
Fire‑sifret kode som identifiserer kommunen. |
MunicipalityName (kommunenavn) |
Person‑API (SSB) | String | Harstad - Hárstták |
Navnet på kommunen. Noen kommuner har også navn på samisk. |
CountyNumber (fylkesnummer) |
Person‑API (SSB) | String | 55 |
To‑sifret kode som identifiserer fylket. |
CountyName (fylkesnavn) |
Person‑API (SSB) | String | Troms - Romsa - Tromssa |
Navnet på fylket. Også her kan samiske navn forekomme. |
Person‑API bruker klassifikasjonene fra Statistisk sentralbyrå (SSB) for å hente inn denne informasjonen:
Disse to klassifikasjonene kombineres til et enkelt datasett som knytter alle kommuner til sine tilhørende fylker i Norge. Endringer i kommune‑ eller fylkesinndeling er sjeldne, men datasettet oppdateres daglig i Person‑API.
Datasettet for 2024 kan lastes ned fra følgende URL:
Eller du kan hente det som JSON ved å kjøre følgende curl‑kommando:
curl -X "GET" "https://data.ssb.no/api/klass/v1/classifications/131/correspondsAt?date=2024-01-01&targetClassificationId=104" -H "Accept: application/json"
Nedenfor kan du se et JSON‑eksempel på kommune‑ og fylkesinformasjon som er inkludert i opplysningene om sivilstatus.
Json eksempel
"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
}
]
Grunnstatistiske enheter (grunnkrets) og bydel
Her er en kort oversikt over adresser som kan inneholde grunnstatistiske enheter og bydeler:
| Adresse‑type | Garanti for grunnstatistisk enhet | Kilder til grunnstatistisk enhet | Garanti for bydel (i by) |
|---|---|---|---|
| Bostedsadresse | Ja | FREG (BasicStatisticalUnit) Person‑API (FullBasicStatisticalUnitNumber) |
Ja |
| Oppholdsadresse | Nei | Person‑API (FullBasicStatisticalUnitNumber) | Nei |
| Delt bosted | Nei | Person‑API (FullBasicStatisticalUnitNumber) | Nei |
Nedenfor vises et JSON‑eksempel på en bostedsadresse som inkluderer grunnstatistisk enhet, bydel, samt kommune‑ og fylkesinformasjon.
Json eksempel
"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"
},
"coordinate": {
"epsgCode": 25833,
"north": 7273600,
"east": 454000
},
"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 Grunnstatistiske enheter (grunnkrets)
I Folkeregisteret (FREG) er kun bostedsadressen garantert å være en virkelig adresse i Norge som finnes i Norsk eiendomsregister (Matrikkelen), og dette er den eneste adressen hvor FREG inkluderer en grunnstatistisk enhet.
For oppholds‑ og delt‑bosteds‑ adresser prøver Person‑API å hente en grunnstatistisk enhet ved å slå opp adressen i Norsk eiendomsregister‑datasett, men det er ingen garanti for at en treff finnes, og vi kan derfor ikke alltid levere denne informasjonen.
Grunnstatistiske enheter for adresser leveres i følgende datapunkter for bosteds‑, oppholds‑ og delt‑bostedsadresser:
| Datapunkt | Kilde | Datatype | Eksempel | Leveres for adresser | Beskrivelse |
|---|---|---|---|---|---|
| BasicStatisticalUnit | FREG | Integer | 5218 |
Bostedsadresse | 3‑4‑sifret kode som identifiserer den statistiske enheten innenfor en kommune. |
| FullBasicStatisticalUnitNumber | Person‑API (SSB) | String | 50015218 |
Bostedsadresse Oppholdsadresse Delt‑bostedsadresse |
8‑sifret kode som entydig identifiserer den statistiske enheten i Norge. De fire første sifrene er kommunenummeret. |
| BasicStatisticalUnitName | Person‑API (SSB) | String | MUNKVOLD |
Bostedsadresse Oppholdsadresse Delt‑bostedsadresse |
Navnet på den grunnstatistiske enheten. |
Adressekoordinater
For bosteds‑, oppholds‑ og delt‑bosteds‑ adresser forsøker Person‑API å legge ved koordinater ved å slå opp adressen i Norsk eiendomsregister‑datasett. Det er imidlertid ingen garanti for at adressen finnes i datasettet, og vi kan derfor ikke alltid levere koordinatene.
Koordinat‑objektet kan være null dersom ingen koordinater finnes. Når koordinater er tilstede, indikerer feltet EpsgCode hvilket koordinatsystem (CRS) som benyttes.
Når mulig beriker API‑et resultatet med EUREF89 UTM‑sone 33 (EPSG:25833), som anbefales av GeoNorge for landsdekkende punktdata.
| Datapunkt | Kilde | Datatype | Eksempel | Beskrivelse |
|---|---|---|---|---|
| Coordinate | Person‑API (SSB) | Objekt | { EpsgCode: 25833, North: 7273600, East: 454000 } |
Koordinatsystemet (EpsgCode) og de tilhørende koordinatverdiene. North er nord‑koordinat (eller latitud for EPSG:4258), East er øst‑koordinat (eller longitud for EPSG:4258). |
Bydel (urban districts)
Person‑API inkluderer også data om geografiske og tjenesteytende bydeler for bosteds‑, oppholds‑ og delt‑bosteds‑ adresser. Bydeler kartlegges fra grunnstatistiske enheter, så kun bostedsadresser er garantert å ha denne informasjonen dersom personen bor i en by som har bydeler – dette gjelder per i dag Oslo, Bergen, Stavanger og Trondheim.
| Datapunkt | Definert av | Datatype | Eksempel | Beskrivelse |
|---|---|---|---|---|
| UrbanDistrictCode | Kommune/by | String | 030105 |
Seks‑sifret kode som identifiserer den bydelen som leverer kommunale sosial‑ og helsetjenester for adressen. |
| UrbanDistrictName | Kommune/by | String | Frogner |
Navn på tjenesteytende bydel. |
| GeographicalUrbanDistrictCode | SSB | String | 500101 |
Seks‑sifret kode som identifiserer den geografiske bydelen for adressen. |
| GeographicalUrbanDistrictName | SSB | String | Midtbyen |
Navn på den geografiske bydelen. |
Tjenesteytende bydeler
Tjenesteytende bydeler defineres av kommunen, men kun i Oslo er det en forskjell mellom geografiske og tjenesteytende bydeler. På tidspunktet for skrivingen er Marka og Sentrum geografiske bydeler som ikke er tjenesteytende bydeler; personer som bor der får sine kommunale sosial‑ og helsetjenester fra andre bydeler.
For Oslo oppdateres koblingen fra grunnstatistiske enheter til tjenesteytende bydeler manuelt basert på data fra Plan‑ og bygningsetaten i Oslo kommune.
Geografiske bydeler
Geografiske bydeler er definert av Statistisk sentralbyrå (SSB). Person‑API benytter følgende klassifikasjoner fra SSB:
Disse to klassifikasjonene kombineres til ett datasett som knytter alle statistiske enheter til bydelene i Norge. Datasettet oppdateres daglig i Person‑API. Det gyldige datasettet for 2024 kan lastes ned fra:
Eller du kan skrive det ut som JSON ved å kjøre følgende curl‑kommando:
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"