Aktiv konto API

Sikkerhet

Denne tjenesten støtter både bruk av Maskinporten og virksomhetssertifikat. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

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

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: Aktiv Konto API ekstern.

Grensesnittbeskrivelse

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

URL har følgede oppbygging:

POST https://<env>/api/aktivkonto/ekstern/<versjon>/tin

• <env>: Miljø-spesifikk adresse
• <versjon>: Versjon av endepunktet. Se avsnitt for versjonering.

Request Body

Krever innsending av JSON-objekt med følgende format:

{ "tin": "<personidentifikator>" }

Versjonering

• <v1>: Støtter virksomhetssertifikat.
• <v2>: Støtter maskinporten.
• <v3>: Støtter maskinporten og returnerer feilresponser som følger datasamarbeids feilkode-standard.

Se også generelle regler for versjonering.

Eksempel på spørring til, og respons fra, tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må generere et gyldig Maskinporten-token og legge til i header.

curl -i -X POST 'https://api-test.sits.no/api/aktivkonto/ekstern/v3/tin' -H "Authorization: Bearer <maskinporten token>" -H "Content-Type: application/json"  -d '{"tin": "<personidentifikator>"}'

Suksess (HTTP status 200 eller 204)

Dersom kallet lykkes får man enten HTTP status 200 og data i JSON-format eller 204 og tom respons, om personen ikke har noen konti.

JSON

{
  "tin":"17816994780",
  "kontoDto": {
    "kontonummer":"32432567604",
    "kontotype":"innskuddskontoINOK",
    "skattekontoegnethet":"brukskonto",
    "bicEllerSwift":null,
    "bankkode":null,
    "bankNavn":"Bank1",
    "bankLandkode":null,
    "iban":null,
    "valuta":null,
    "erUtbetalingskort":false,
    "valgtDato":"2020-03-23"
  }
}

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200 eller 204, 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": "AKE-002",
  "melding": "Fant ikke partsnummer for oppgitt tin",
  "korrelasjonsid": "3f5fa638-ecd3-4764-87c5-724073895706"
}

Informasjonsmodell og beskrivelse av felter

Informasjonsmodell og beskrivelse av felter.

Feilkoder

Se også den generelle informasjonen om statuskoder og feilmeldinger.