Folkeregister

Fiks folkeregister

Fiks folkeregister er en tjeneste for å gjøre oppslag, uttrekk og hente ut hendelseslister fra Skatteetate sitt Folkeregister (FREG). Fiks folkeregister speiler konsument tjenestene til Skatteetaten på Fiks plattformen. Mer informasjon om Fiks folkeregister finner man her.

Fiks folkeregister tilbyr tilgang til folkeregisteret via

  • Søkeportal
  • Maskin-til-maskin-integrasjon

For å ta i bruk Fiks folkeregister må man inngå bruksavtaler både med skatteetaten og KS. Klikk her for mer informasjon.

Når avtalene er inngått kan en administrator i kommunen/fylkeskommunen sette opp løsningen. Dette må gjøres før fagsystemene og saksbehandlere kan ta i bruk tjenesten. Bilde som beskriver sammenheng mellom de kommunale aktørene

Hva må være på plass før man kan integrere

Kommune/Fylkeskommune

Dere må:

  • Ha inngått avtaler med Skatteetaten og KS, samt delegert tilgang til KS, klikk her for mer informasjon.
  • Ha virksomhetssertifikat for de miljøene dere skal være koblet opp i
  • Ha avtale med Difi om bruk av maskinporten
  • Kontakt (fiks-utvikling@ks.no) oss og be om å få tilgang til scopet ks:fiks. Husk å oppgi organisasjonsnummeret det gjelder. (Samme nummer som virksomhetssertifikatet er utstedt til.)
  • Opprett maskinportenklient som konfigureres opp med ks:fiks-scopet

Leverandører

Dere må:

  • Ha virksomhetssertifikat for de miljøene dere skal være koblet opp i
  • Ha avtale med Difi om bruk av maskinporten
  • Kontakt (fiks-utvikling@ks.no) oss og be om å få tilgang til scopet ks:fiks, samt tilgang til Fiks-plattformen (testmiljø). Husk å oppgi organisasjonsnummeret det gjelder. (Samme nummer som virksomhetssertifikatet er utstedt til.)
  • Opprett maskinportenklient som konfigureres opp med ks:fiks-scopet

Felles

Når dere har fått tilgang til Fiks-plattformen må dere:

  • Sette opp Fiks-folkeregister-tjenesten
  • Lage en eller flere roller
  • Opprette en eller flere integrasjon gi integrasjonen tilgang til rollen(e).

Jeg er utvikler og ønsker å integrere

Du er klar til å integrere mot Fiks folkeregister når du har følgende tilgjengelig:

  • virksomhetssertifikat
  • maskinportenklientid
  • rolleid
  • integrasjon (brukernavn og passord)

Roller og dataminimering

Fiks folkeregister har introdusert roller for å styring av tilgang til FREG. En rolle blir brukt for å begrense opplysninger som kan hentes ut fra Folkeregisteret. Alle forespørsler må gjøres i kontekst av en rolle. En rolle inneholder begrensninger for hvilke hjemler som er tillatt, hvilke bruksområder den skal brukes til og hvilke informasjonselementer som er tillatt å hente ut fra folkeregisteret.

Skatteetaten har laget en egen side for dataminimering. Rollene får tildelt “parts”/egenskaper (informasjonselementer) fra ut fra dataminimeringsoversikten. En rolle kan bare hente informasjonselementer som er definert i rollen og forsøk på å hente informasjonselementer ut over det som er definert resulterer i en feilmelding.

I dokumentasjonen til API-et til FREG står det Dersom part ikke oppgis vil retur innholde samme informasjon som finnes i "person-basis". En forespørsel med en rolle som ikke har tilgang til hele “person-basis” blir avvist dersom man ikke oppgir “parts”/egenskaper.

Miljøer OpenAPI/Swagger og oppbygging av endepunkter**

Miljø URL
Test (Integrasjon) https://api.fiks.test.ks.no
Produksjon https://api.fiks.ks.no

Våre API er en speiling av FREG og vi tilbyr derfor ikke egne OpenAPI/Swagger-dokumentasjon. Klikk her for FREG sin Swagger-dokumentasjon.

Les mer om hvordan tjenestene virker hos Skatteetaten:

Vi har en annen oppbygging av URL-stien enn Skatteetaten. Vi har erstattet rettighetspakke (offentlig med hjemmel og offentlig uten hjemmel) med en rolleid.

URL-sti for Fiks sitt proxy-api er på formen: <MILJØ_URL>/folkeregister/api/v1/{ROLLE_ID}/{FREG_RESSURS}

  • ROLLE_ID - Id for rollen som brukes
  • FREG_RESSURS - URL-sti for oppslag/uttrekk/hendelser fra skatteetatens api, på formen med eksempel v1/personer/{personidentifikator}

Merk at dette er URL-stien som skal brukes uavhengig av om fagsystemet bruker api for offentlig med hjemmel eller offentlig uten hjemmel, da det er rollen som definerer hvilken som blir brukt.

Eksempel på bruk av API-et

Eksempelet er utført med httpie: http --pretty format GET https://api.fiks.test.ks.no/folkeregister/api/v1/<ROLLE_ID>/v1/personer/06076301709?part=bostedsadresse Accept: application/json IntegrasjonId:<INTEGRASJONSID> Authorization:Bearer <JWT_TOKEN_FRA_MASKINPORTEN> IntegrasjonPassord:<INTEGRASJONSPASSORD>

{
	"bostedsadresse": [{
		"aarsak": "Årsakskode fra DSF: ",
		"adresseIdentifikatorFraMatrikkelen": "510430318",
		"adressegradering": "ugradert",
		"ajourholdstidspunkt": "2020-03-24T00:00:00+01:00",
		"erGjeldende": true,
		"grunnkrets": 5102,
		"gyldighetstidspunkt": "2020-03-24T00:00:00+01:00",
		"kilde": "KILDE_DSF",
		"kirkekrets": 2,
		"skolekrets": 160,
		"stemmekrets": 1701,
		"vegadresse": {
			"adressekode": "00001",
			"adressenavn": "Ospeskogveien",
			"bruksenhetsnummer": "H0101",
			"bruksenhetstype": "fritidsbolig",
			"coAdressenavn": "",
			"kommunenummer": "0301",
			"poststed": {
				"postnummer": "0758",
				"poststedsnavn": "OSLO"
			}
		}
	}],
	"identifikasjonsnummer": [{
		"ajourholdstidspunkt": "2020-03-25T20:14:54.736+01:00",
		"erGjeldende": true,
		"foedselsEllerDNummer": "06076301709",
		"identifikatortype": "foedselsnummer",
		"kilde": "KILDE_DSF",
		"status": "iBruk"
	}]
}

Kontakt

Tekniske spørsmål og henvendelser kan rettes til fiks-utvikling@ks.no, øvrige henvendelser kan rettes til modernisertfolkeregister@ks.no