Tjenesten leverer informasjon om navn og adresse for skattepliktige personer.

Sikkerhet

Denne tjenesten støtter kun bruk av maskinporten. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:skattepliktig

Delegering

Tilgang til denne tjenesten kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen. Søk opp følgende tjeneste i Altinn for å delegere tilgangen: Skattepliktig API.

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.

URL-en har følgede oppbygging:

GET https://{env}/api/part/skattepliktig/{rettighetspakke}/{personidentifikator}
  • env: Miljø-spesifikk adresse
  • rettighetspakke: Rettighetspakken distribusjon er eneste rettighetspakken for denne tjenesten
  • personidentifikator: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Skattepliktig API

Støttetjenester

Hendelsesliste

For å følge med på hvilke skattepliktige som har endringer i navn og adresse tilbyr vi en hendelsesliste. URL er:

GET https://{env}/api/part/skattepliktig/hendelser/

Se felles API-dokumentasjon for hendelseslister for bruk.

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.

$ curl -v -H "Authorization: Bearer <maskinporten_token>" "https://api-test.sits.no/api/part/skattepliktig/distribusjon/18018188888"

Suksess (HTTP status 200)

Dersom kallet lykkes får man HTTP status 200 og data i JSON eller XML format. Dersom man ikke spesifiserer ønsket format får man JSON.

JSON

{  
   "person":{  
      "personidentifikator":"18018188888",
      "navn":{  
         "fornavn":"OLA",
         "mellomnavn": "KALED",
         "etternavn":"NORDMANN"
      },
      "bostedsadresse":{  
         "adresse1":"NORD-STATLAND 411 Å",
         "tilleggsadresse":"c/o Per Post",
         "postnummer":"1234",
         "kommunenummer":"1749",
         "registreringsdato":"2017-01-24"
      },
      "postadresse":{  
         "adresse1":"Ole Danviks gate 10",
         "adresse2":"H0101",
         "adresse3":"1234 Oslo",
          "land":{
             "landnummerDsf":"0",
             "landkodeIsoAlfa2":"NO"
          },
         "registreringsdato":"2018-01-20"
      },
      "hjemlandsadresse":{  
         "adresse1":"Kaled Dome 1337 Kaalann, Skaro",
         "adresse2":"Madrid",
         "adresse3":"SPANIA",
         "land":{
            "landnummerDsf":"34",
            "landkodeIsoAlfa2":"ES"
         },
         "registreringsdato":"2016-08-01"
      },
      "doedsdato" :"2018-04-30",
      "klientadresse" :false,
      "utenFastBopel" :false
   },
   "skjermet":false
}

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml

skattepliktig.xml (eksempel) (vanlig)

skattepliktig_skjermet.xml (eksempel) (skjermet person)

skattepliktig_skjermet_adresse.xml (eksempel) (person som bor på institusjon med adresse-skjerming)

skattepliktig_skjermet_bostedloes.xml (eksempel) (person som er bostedsløs)

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.

JSON

{  
   "kode":"SKATTEPLIKTIG-008",
   "melding":"Fant ingen informasjon på oppgitt personidentifikator",
   "korrelasjonsid":"9268c633-f8a9-4ec0-a984-913c214b1f9b"
}

XML

Dersom Accept-header er satt til application/xml vil også eventuell feilmelding være i XML.

Feilkoder

Tabellen under viser en oversikt over hvilke typer feil applikasjonen kan gi. Feilmeldingen vil kunne variere selv om samme feilkode returneres. Dette er for å kunne gi en så presis beskrivelse av feilen som mulig. Ved vedvarende feil vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra feilmelding.

Feilkode HTTP Statuskode Feilområde
SKATTEPLIKTIG-001 500 Uventet feil på tjenesten.
SKATTEPLIKTIG-002 500 Uventet feil i et bakenforliggende system.
SKATTEPLIKTIG-003 404 Ukjent url benyttet.
SKATTEPLIKTIG-004 401 Feil i forbindelse med autentisering.
SKATTEPLIKTIG-005 403 Feil i forbindelse med autorisering.
SKATTEPLIKTIG-006 400 Feil i forbindelse med validering av inputdata.
SKATTEPLIKTIG-007 404 Ingen treff på oppgitt personidentifikator.
SKATTEPLIKTIG-008 404 Ingen skattepliktig funnet med oppgitt personidentifikator.
SKATTEPLIKTIG-009 406 Feil tilknyttet dataformat. Kun json eller xml er støttet.
Tags: