Brønnøysundregistrene tilbyr en begrenset, standardisert maskin-til-maskin-tjeneste (API) som kan benyttes av eksterne partnere for innsyn i ektepakter fra Ektepaktregisteret.
Denne dokumentasjonen viser hvordan eksterne systemer kan integrere seg mot APIet, og hvordan man benytter seg av tjenesten for å hente data.
Det er også blitt opprettet en referanseapplikasjon for å gjøre det enklere å se hvordan man skal integrere. Koden for denne er lagt ut i brreg sitt repository på github: refapp-integrasjon
For enkelte fødselsnummer kan det være registrert et stort antall ektepakter i vårt testmiljø. Ved oppslag på disse kan du oppleve time-out feilmelding. Forsøk da oppslag på en annen identifikator. Brønnøysundregistrene benytter selv det samme testmiljøet, og testdataene er ikke statisk. Disse endres kontinuerlig basert på vår egen testing, samt tinglysning i vårt testmiljø som utføres av eksterne brukere. Du vil også sporadisk kunne finne testdata som har innhold som ikke er i henhold til forretningsregler, eller testdata som er mangelfulle.
Denne tjenesten tilbyr opplysninger om:
Dokumentasjon er også tilgjengelig i Swagger:
Eksempel på request- og response-objekter (implementert i Java) for APIet kan sees her: refapp-integrasjon DTOer
Siden dette er begrensede API så skal kallende parter autentiseres gjennom Maskinporten.
For å kunne få tilgang til våre begrensede API er det tre forutsetninger:
brreg:ektepakt/tlgTokenet som hentes fra Maskinporten må bli sendt som autorisasjonstoken (Bearer token) når et kall mot Løsøreregisteret blir utført.
Se veiledning for integrasjon mot Maskinporten.
Regelverk: Hjemler for tilgjengeliggjøring av data fra Brønnøysundregistrene.
Oversikt over HTTP-statuskoder i APIet.
| HTTP-kode | Beskrivelse |
|---|---|
| 200 OK | Henting av data gikk bra |
| 400 Bad Request | Feil i spørring. Applikasjonen vil gi en detaljert feilmelding for hva som er feil med spørring |
| 403 Forbidden | Feil ved autentisering eller autorisering. Bearer tokenet som ble sendt inn er ikke gyldig eller har ikke en gyldig avtale om maskinelt oppslag på opplysninger i Løsøreregisteret |
| 500 Internal Server Error | Feil på server side, for eksempel at en underliggende datakilde ikke svarer |
Definisjoner på begrep som er brukt i denne dokumentasjonen.
| Begrep | Definisjon |
|---|---|
| fnr | Fødselsnummer for person |
| d-nummer | Identifikasjonsnummer som tildeles personer med midlertidig tilknytning til Norge, det vil si som ikke er bosatt i Norge. Består av en modifisert sekssifret fødselsdato og et femsifret personnummer. Fødselsdatoen modifiseres ved at det legges til 4 på det første sifferet. |
| ektepakt | Avtale om formuesordningen mellom ektefeller |