*Tjenesten er under utvikling, og endring i dokumentasjon på denne siden kan forekomme uten varsel. DSOP Forvaltning
vil kontakte alle relevante kontaktpersoner når dokumentasjonen er ferdigstilt.*
Kontrollinformasjon - Innhenting av kontoinformasjon til Skatt/Namsmannen
Tjenesten er basert på DSOP Kontrollinformasjon fellesstandard og gjelder utlevering av kontoopplysninger til skatteetaten og Namsmannen. Se Juridiske rammebetingelser for tjenesten FI-Utlegg Saldo.
Trinn 1 - DSOP Oversikt over kundeforhold
Skatteetaten skal bruke endepunktet customerRelationships på følgende måte:
| Input-felter | Beskrivelse |
|---|---|
| Authorization | Gyldig token fra Maskinporten (bits:kundeforhold). |
| CustomerID | FNR/D-NR eller orgnr til kontrollobjektet. |
| CorrelationID | Uuid-verdi for unik teknisk referanse til forespørselen. |
| Legal-Mandate | Lovhjemmel er: “FI-Utlegg-Test-IM” for Innkrevingsmyndighetene og “FI-Utlegg-Test-AN” for alminnelig lensmann. URL Encoded verdien skal altså være “FI-Utlegg-Test-IM” eller “FI-Utlegg-Test-AN”. |
| AccountInfoRequestID | Uuid-verdi for saksnummer i Skatteetaten. |
| fromDate | Kun dagens dato. |
| toDate | Kun dagens dato. |
| onlyPrimaryOwner | FI-Utlegg har kun mulighet til å bruke “onlyPrimaryOwner” = “TRUE”. |
Se datamodell for customerRelationships.
Trinn 2 a og b - DSOP Kontrollinformasjon
Generell informasjon
| Informasjon om | Beskrivelse | Link |
|---|---|---|
| Funksjonell spesifikasjon | Den funksjonelle spesifikasjonen for DSOP Kontrollinformasjon fellesstandard gjelder for tjenesten FI-Utlegg Saldo. | Dokumentasjon på engelsk: Functional specification DSOP Control Common Standard. |
| Informasjon om volum og responstider | Responstidene kan variere mellom finansinstitusjoner, men det typiske mønsteret er at forespørsler etter data vil ha raske responstider (sekunder), mens store historiske forespørsler kan ta lengre tid. Volum for tjenesten FI-Utlegg Saldo. - Det forventes følgende volum fra skatteetaten/Namsmannen per år for forespørsel om kontoliste og kontodetaljer: Blir oppgitt ved en senere anledning |
|
| Sikkerhetsdokumentasjon | Sikkerhetsdokumentasjon for DSOP Kontrollinformasjon fellesstandard gjelder for tjenesten FI-Utlegg Saldo. | Sikkerhetsdokumentasjon. |
| Arkitektur | Arkitektur for DSOP Kontrollinformasjon fellesstandard gjelder for tjenesten FI-Utlegg Saldo. | Dokumentasjon på engelsk: Architecture documentation. |
| API-spesifikasjon | Følgende endepunkter inngår i tjenesten FI-Utlegg Saldo: - Accounts - Account details Finansforetakene skal påse at FI-Utlegg Saldo tjenesten ikke får tilgang til endepunktene Transactions, Roles og Cards. Det er minimum versjon 2.0 av DSOP Kontroll API-et som skal benyttes for tjenesten. Finansforetakene skal returnere en HTTP 400 med ACC-001 og best mulig feilbeskrivelse dersom etat sender en forespørsel til ugyldige endepunkter. Se HTTP-feilkoder og spesifikke feilsituasjoner med tilhørende meldingskoder. |
Dokumentasjon på engelsk: API-specification. |
| Overordnet spesifikasjon av DSOP-Kontroll API-et | Den overordnede spesifikasjon av DSOP Kontroll API-et for DSOP Kontrollinformasjon fellesstandard gjelder for løsningen FI-Utlegg Saldo. | Overall description of the DSOP Control API |
| Integrasjonstesting | Definerte test-caser for DSOP Kontrollinformasjon fellesstandard gjelder for tjenesten FI-Utlegg Saldo. | Internal testing / quality assurance DSOP Control Common Standard. |
Tillatte endepunkter i trinn 2 for tjenesten FI-Utlegg Saldo
| Endepunkter | Scope fra Maskinporten | Minimum nødvendig versjon av API |
|---|---|---|
| Accounts (kontoliste) Account Details (kontodetaljer) |
bits:kontoinformasjon |
V.2.0 |
Gyldig forespørsel - Trinn 2a
Skatteetaten/Namsmannen skal bruke endepunktet Accounts på følgende måte:
| Input-felter | Beskrivelse |
|---|---|
| AccountInfoRequestId | Uuid-verdi for et saksnummer i løsningen hos Skatteetaten/Namsmannen. |
| CorrelationID | Uuid-verdi for unik teknisk referanse til forespørselen. |
| Legal-Mandate | Lovhjemmel er: “FI-Utlegg-Test-IM” for Innkrevingsmyndighetene og “FI-Utlegg-Test-AN” for alminnelig lensmann. URL Encoded verdien skal altså være “FI-Utlegg-Test-IM” eller “FI-Utlegg-Test-AN”. |
| PartyID | FNR/D-NR eller Org. nr. til kontrollobjektet. |
| onlyPrimaryOwner | Kun “onlyPrimaryOwner” = “TRUE”. |
| AdditionalReferenceID | Ingen data. |
| AdditionalReferenceIDType | Ingen data. |
| RequesterID | Ingen data i test, men vil kunne endres ifm. løsningsforslag. |
| fromDate | Dagens dato. |
| toDate | Dagens dato. |
Se datamodell for Accounts.
Gyldig forespørsel - Trinn 2b
Etter vellykket response fra 2a, skal Skatteetaten/Namsmannen videre bruke endepunktene Account Details på følgende måte:
| Felter | Beskrivelse |
|---|---|
| accountReference | Unik referanse til kontoen. |
| AccountInfoRequestID | Samme definisjon som for Accounts. |
| CorrelationID | Samme definisjon som for Accounts. |
| Legal-Mandate | Samme definisjon som for Accounts. |
| AdditionalReferenceID | Samme definisjon som for Accounts. |
| AdditionalReferenceIDType | Samme definisjon som for Accounts. |
| RequesterID | Samme definisjon som for Accounts. |
| fromDate | Samme definisjon som for Accounts. |
| toDate | Samme definisjon som for Accounts. |
Se datamodell for:
Utlevering av datafelter per endepunkt
Finansforetakene skal utlevere kontoopplysninger for denne tjenesten iht. gjeldende datamodell for DSOP Kontrollinformasjon API. Se Description of all input- and output parameters in the APIs.
Kategorisering av utlevering av kontoopplysninger på feltnivå:
- Teknisk obligatorisk: Denne opplysningen skal utleveres, ettersom det er teknisk påkrevet i API-et. Det er viktig å ta hensyn til forkortelsene (M, D og MC) fra datamodellen i DSOP Kontroll API-et når det gjelder utlevering av obligatoriske felter, spesielt der finansforetak ikke har mulighet til å utlevere data.
- Skal utleveres: Etaten har behov for denne opplysningen, og tjenesten skal derfor utlevere den dersom finansforetaket har informasjonen tilgjengelig.
- Kan filtreres bort: Etaten har ikke behov for denne opplysningen, og finansforetaket kan velge å utelate den fra utleveringen. Dersom etaten mottar denne opplysningen, skal den slettes.
- Utleveres ikke: Finansforetak vil ikke levere opplysning gjennom datafeltet.
- Til vurdering: Denne kategorien brukes for felt som ennå ikke er avklart. Det betyr at det fortsatt pågår en vurdering av om opplysningen skal utleveres eller ikke.
Overordnede prinsipper for utlevering definert i DSOP Kontrollinformasjon fellesstandard vil gjelde for denne tjenesten.
Utlevering for Accounts (Kontoliste):
“Kontoliste” er det første endepunktet etat vil benytte for å få utlevert en liste over konti som tilhører kontrollobjektet. Videre bruk av tjenesten baseres på dette Kontoliste-kallet.
For tjenesten Konkursbehandling gjelder følgende utlevering fra Kontoliste:
- Liste over konti som skyldneren eide i den gjeldende tidsperioden.
Se gyldig forespørsel for endepunktet Accounts.
Finansforetakene skal utlevere kontoopplysninger fra dette endepunktet etter overordnede prinsipper for utlevering definert i DSOP Kontrollinformasjon fellesstandard.
Videre er retningslinjene for utlevering av data per felt for dette endepunktet beskrevet i tabellen nedenfor, i henhold til kategoriseringen definert i Utlevering av datafelter per endepunkt.
| Svar fra Accounts | Datautlevering |
|---|---|
| responseDetails.status | Teknisk obligatorisk |
| responseDetails.message | Skal utleveres |
| accounts.status | Skal utleveres |
| accounts.servicer.identifier.countryOfResidence | Skal utleveres |
| accounts.servicer.identifier.value | Teknisk obligatorisk |
| accounts.servicer.identifier.type | Teknisk obligatorisk |
| accounts.servicer.name | Skal utleveres |
| accounts.accountIdentifier | Teknisk obligatorisk |
| accounts.accountReference | Teknisk obligatorisk |
| accounts.type | Skal utleveres |
| accounts.currency | Skal utleveres |
| accounts.primaryOwner.permission | Skal utleveres |
| accounts.primaryOwner.identifier.countryOfResidence | Skal utleveres |
| accounts.primaryOwner.identifier.value | Teknisk obligatorisk |
| accounts.primaryOwner.identifier.type | Teknisk obligatorisk |
| accounts.primaryOwner.name | Skal utleveres |
| accounts.primaryOwner.startDate | Skal utleveres |
| accounts.primaryOwner.endDate | Skal utleveres |
| accounts.name | Utleveres ikke |
| links.rel | Teknisk obligatorisk |
| links.href | Teknisk obligatorisk |
Utlevering for Account Details (Kontodetaljer):
Finansforetakene skal utlevere kontoopplysninger fra dette endepunktet etter overordnede prinsipper for utlevering definert i DSOP Kontrollinformasjon fellesstandard.
Videre er retningslinjene for utlevering av data per felt for dette endepunktet beskrevet i tabellen nedenfor, i henhold til kategoriseringen definert i Utlevering av datafelter per endepunkt.
| Svar fra AccountDetails | Datautlevering |
|---|---|
| responseDetails.status | Teknisk obligatorisk |
| responseDetails.message | Skal utleveres |
| account.status | Skal utleveres |
| account.servicer.identifier.countryOfResidence | Skal utleveres |
| account.servicer.identifier.value | Teknisk obligatorisk |
| account.servicer.identifier.type | Teknisk obligatorisk |
| account.servicer.name | Skal utleveres |
| account.accountIdentifier | Teknisk obligatorisk |
| account.accountReference | Teknisk obligatorisk |
| account.type | Skal utleveres |
| account.currency | Skal utleveres |
| account.name | Utleveres ikke |
| account.balances.creditLineIncluded | Skal utleveres |
| account.balances.amount | Skal utleveres |
| account.balances.creditDebitIdicator | Skal utleveres |
| account.balances.registered | Skal utleveres |
| account.balances.type | Skal utleveres |
| account.balances.creditLineAmount | Skal utleveres |
| account.balances.creditLineCurrency | Skal utleveres |
| account.balances.currency | Skal utleveres |
| account.primaryOwner.permission | Skal utleveres |
| account.primaryOwner.identifier.countryOfResidence | Skal utleveres |
| account.primaryOwner.identifier.value | Teknisk obligatorisk |
| account.primaryOwner.identifier.type | Teknisk obligatorisk |
| account.primaryOwner.name | Skal utleveres |
| account.primaryOwner.startDate | Skal utleveres |
| account.primaryOwner.endDate | Skal utleveres |
| account.startDate | Skal utleveres |
| account.endDate | Skal utleveres |
Datavalidering
Det er finansforetakenes ansvar å validere forespørsler fra etat og det er opp til finansforetakene å sørge for at alle forespørsler fra etat blir validert godt nok. Ved å validere og logge input-parametere fra etat riktig, vil finansforetakene være bedre egnet til å unngå levering av overskuddsinformasjon. Implementering av slik logikk er finansforetakenes ansvar.
For å sikre godt kontrollnivå på tvers av finansforetakene, er det beskrevet et sett med anbefalinger om generelle og generiske valideringer i DSOP Kontrollinformasjon fellesstandard og spesifikke valideringer knyttet til tjenesten FI-Utlegg Saldo.
Generelle og generiske valideringer
Disse er beskrevet på «Generic DSOP Control validations».
Org.nr. til Skatteetaten er 974761076.
Spesifikke valideringer for Skatt-Kontroll
- Gyldig input-parameter for Skatt-Kontroll:
- Tilgangstoken fra Maskinporten: Finansforetakene må validere token fra Maskinporten med følgende scope:
bits:kontoinformasjon - Input parameter for FI-Utlegg Saldo: Se gjeldende API-spesifikasjon for teknisk beskrivelse: API Specification
- Tilgangstoken fra Maskinporten: Finansforetakene må validere token fra Maskinporten med følgende scope:
For Accounts:
| Input parametere | Forventet verdi | Forslag til validering | |
|---|---|---|---|
| AccountInfoRequestID (M) | Uuid referanse til saksnr. | Formatet kan valideres. I tillegg kan denne parameteren valideres iht definisjonen i Overall description of the DSOP Control API. | |
| CorrelationID (M) | Uuid verdi til en unik teknisk referanse for forespørselen. | Formatet kan valideres. I tillegg kan denne parameteren valideres iht definisjonen i Overall description of the DSOP Control API. | |
| Legal-Mandate (M) | “FI-Utlegg-Test-IM” eller “FI-Utlegg-Test-AL” | Strengen skal være I ‘encoded’ format og burde valideres iht til Juridiske rammebetingelser FI-Utlegg. | |
| PartyID (M) | Kontrollbjektet: Organisasjonsnummer, FNR eller D.NR. | Formatet kan valideres. | |
| OnlyPrimaryOwner (M) | “TRUE” | FI-Utlegg Saldo skal kun tillate verdien “TRUE”. | |
| AdditionalReferenceID (O) | Ingen | - | |
| AdditionalReferenceIDType (O) | Ingen | - | |
| RequesterID (O) | Representasjon av brukerID til saksbehandleren. | Verdi må finnes i forespørselen. | |
| fromDate (M) | Dagens dato. dato. | Formatet kan valideres. I tillegg bør verdien også valideres slik at datoen kun er dagens dato. | |
| toDate (M) | Dagens dato. | Formatet kan valideres. I tillegg bør verdien også valideres slik at datoen kun er dagens dato. |
Se HTTP error codes and specific error situations with associated message codes.
For de andre endepunktene:
| Input parametere | Forventet verdi | Forslag til validering | |
|---|---|---|---|
| AccountReference (M) | Uuid referanse til kontonr. | - | |
| AccountInfoRequestID (M) | Uuid referanse til saksnr. | Samme som for Accounts. | |
| CorrelationID (M) | Uuid verdi til en unik teknisk referanse for forespørselen. | Samme som for Accounts. | |
| Legal-Mandate (M) | “FI-Utlegg-Test-IM” eller “FI-Utlegg-Test-AL”. | Samme som for Accounts. | |
| AdditionalReferenceID (O) | Ingen | - | |
| AdditionalReferenceIDType (O) | Ingen | - | |
| RequesterID (O) | Representasjon av brukerID til saksbehandleren. | Samme som for Accounts. | |
| fromDate (M) | Opptil 10 år før dagens dato. | Samme som for Accounts. | |
| toDate (M) | Dagens dato. | Samme som for Accounts. |
Se HTTP error codes and specific error situations with associated message codes.
Endringslogg
| Dato | Versjon | Endring |
|---|---|---|
| 25.08.25 | 0.6 | Kapittel om validering ble lagt til. |
| 20.03.25 | 0.5 | Første versjon av dokumentasjon i prosjektet. |