Ektepakt knyttet til person

Grensesnittbeskrivelse

HTTP-metodeURLBeskrivelse
GEThttps://{domene}/api/v1/fnr/{fnr}?spraakkode={spraakkode}Hent opplysninger om ektepakter knyttet til et fødselsnummer eller d-nummer. Spraakkode er valgfri.

Domener:

  • For testmiljø (ppe) https://ektepaktregisteret.ppe.brreg.no/ektepakt
  • For produksjon https://ektepaktregisteret.brreg.no/ektepakt

Oppslag på fødselsnummer

Beskrivelse

Tjenesten tar imot en forespørsel om oppslag på et fødselsnummer eller d-nummer, forespørselen valideres før utførelsen og returnerer opplysninger om kun aktive ektepakter på fødselsnummeret eller d-nummeret.

Request

Tar i mot et fødselsnummer eller d-nummer (fnr) som del av URL. Den valgfrie query parameteren “spraakkode” angir språkkode (ISO 639-2) for hvilket språk som skal benyttes for beskrivelser i responsen. Hvis den ikke er angitt benyttes norsk bokmål (NOB).

Validering

  • Maskinport-tokenet som blir sendt inn er knyttet til avtalepartens orgnummer, og dette orgnummeret skal være gyldig samt ha en gyldig avtale om å kunne hente ut opplysninger i Ektepaktregisteret.
  • Forespørselen skal alltid inneholde fnr som det gjøres oppslag på.
  • Dersom forespørselen inneholder et fnr som ikke er lovlig oppbygd, returneres det en feilmelding.
  • Det sjekkes at avtalepartens organisasjonsnummer er registrert og ikke slettet i Enhetsregisteret. Dersom det ikke er registrert, eller er slettet, returneres det en feilmelding.
  • Hvis “spraakkode” er angitt må verdien være en støttet språkkode, hvis ikke returneres det en feilmelding med informasjon om støttede språkkoder.

Response

Dersom kallet lykkes får man HTTP-status 200 og data fra tjenesten på JSON-format, i form av et JSON-objekt som inneholder opplysninger om ektepakten(e). Avtaletyper leveres i korrekt sortert rekkefølge i responsen.

Eksempelrespons
{
  "rolleinnehaver": "06821349425",
  "antallEktepakt": 1,
  "oppslagstidspunkt": "2023-09-05T16:39:55.373958263+02:00",
  "spraak": "NOB",
  "ektepakt": [
    {
      "ektepaktnummer": 1,
      "innkomsttidspunkt": "2023-06-01T05:30:00+02:00",
      "ektepakttype": "ektepakttype.ektepakt",
      "ektepakttypebeskrivelse": "Ektepakt",
      "status": "ektepaktstatus.tinglyst",
      "statusbeskrivelse": "Tinglyst",
      "opprettelse": "opprettelsestype.foersteOpprettelse",
      "opprettelsestypebeskrivelse": "Første gangs opprettelse av ektepakt",
      "harSupplerendeOpplysningerIDokument": false,
      "paategning": [],
      "avtaleinnhold": [
        {
          "avtaletype": "avtaletype.fulltSaereie",
          "avtaletypebeskrivelse": "Vi skal ha fullt særeie"
        }
      ],
      "rolle": [
        {
          "rolletype": "rolletype.ektefelle",
          "rolletypebeskrivelse": "Ektefelle",
          "person": {
            "navn": {
              "fornavn": "AUTORISERT",
              "etternavn": "INNHEGNING"
            },
            "adresse": {
              "adresseType": "adressetype.vegadresse",
              "brukskategori": "bostedsadresse",
              "adressenavn": "Gaukvegen",
              "nummer": {
                "nummer": "13"
              },
              "bruksenhetsnummer": "H0101",
              "poststed": {
                "navn": "KONGSVINGER",
                "postnummer": "2209"
              },
              "kommune": {
                "kommunenummer": "3401",
                "kommunenavn": "Kongsvinger"
              }
            }
          },
          "avtaleinnhold": []
        },
        {
          "rolletype": "rolletype.ektefelle",
          "rolletypebeskrivelse": "Ektefelle",
          "person": {
            "navn": {
              "fornavn": "SORGLØS",
              "etternavn": "BOLLE"
            },
            "adresse": {
              "adresseType": "adressetype.vegadresse",
              "brukskategori": "bostedsadresse",
              "adressenavn": "Kløvåsen",
              "nummer": {},
              "bruksenhetsnummer": "H0101",
              "poststed": {
                "navn": "RAMNES",
                "postnummer": "3175"
              },
              "kommune": {
                "kommunenummer": "3803",
                "kommunenavn": "Tønsberg"
              }
            }
          },
          "avtaleinnhold": [
            {
              "avtaletype": "avtaletype.saereieBlirFelleseieVedRolleSinDoed",
              "avtaletypebeskrivelse": "Særeie blir felleseie om jeg dør først"
            }
          ]
        }
      ]
    }
  ]
}

Feilmeldinger

Dersom man ikke får HTTP-status 200, så får man en melding fra tjenesten i JSON-format. Hvis det er ingen treff får man fortsatt 200-status.

HTTP-kodeFeilmelding
400Feil i fødselsnummer, vennligst prøv på nytt
403Feil under autentisering av abonnent
500Tjenesten feilet på serversiden
Eksempelrespons feilmelding
{
  "korrelasjonsid": "41c0b5b3-ed0a-4392-a57a-9bfc57dcd48c",
  "tidspunkt": "2023-08-11T14:27:33.724162177+02:00",
  "feilmelding": "Feil i fødselsnummer, vennligst prøv på nytt"
}