Tilbyr informasjon om navn og adresse for skattepliktige personer

Grensesnittbeskrivelse

For å bruke grensesnittet kreves autentisering med X.509-sertifikat.

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.

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/

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 --cert datakonsument.cer --key datakonsument.key "https://api-at.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.xsd

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:

feil.xsd

skattepliktig_feil.xml (eksempel)

Feilkoder

Se også felles feilkoder for alle applikasjonene.

Feilkode HTTP Statuskode Feilmelding
SKATTEPLIKTIG-001 500 Fant ikke autentiseringstoken
SKATTEPLIKTIG-002 401 Autentisering feilet
SKATTEPLIKTIG-003 403 Du er ikke autorisert for bruk av dette endepunktet.
SKATTEPLIKTIG-004 500 Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte!
SKATTEPLIKTIG-005 400 Det forespurte identifikator er ikke støttet
SKATTEPLIKTIG-007 406 Oppgitt accept header er ikke gyldig, vennligst velg mellom application/json eller application/xml
SKATTEPLIKTIG-008 404 Fant ingen informasjon på oppgitt personidentifikator

Miljøer

Miljø URL
Akseptansetest (AT) https://api-at.sits.no
Produksjon (Prod) https://api.skatteetaten.no

Ønsker du å komme i kontakt med oss for spørsmål eller andre henvendelser, se veiledning på Skatteetaten.no.

Tags: