### Main method for validation example Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/dokumenter/foedselsEllerDNummerValidator.java Demonstrates calling validerFoedselsnummer with a sample number and expected result. ```java public static void main(String[] args) { // eksempelkjøring System.out.println(validerFoedselsnummer("20036914700", "Gyldig reelt 1964-fødselsnummer", false)); } ``` -------------------------------- ### GET v1/personer/xsd Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter gjeldende XSD-dokument for personopplysninger. ```APIDOC ## GET v1/personer/xsd ### Description Henter gjeldende XSD-dokument for personopplysninger. ### Method GET ### Endpoint v1/personer/xsd ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - Ingen spesifisert ### Bruksmønster Gir gjeldende XSD-dokument for personopplysninger. ``` -------------------------------- ### GET v1/hendelser/xsd Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter gjeldende XSD-dokument for hendelse. ```APIDOC ## GET v1/hendelser/xsd ### Description Henter gjeldende XSD-dokument for hendelse. ### Method GET ### Endpoint v1/hendelser/xsd ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - Ingen spesifisert ### Bruksmønster Gir gjeldende XSD-dokument for hendelse. ``` -------------------------------- ### GET v1/uttrekk/{jobbid}/batch/{batchnr} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter et uttrekk basert på jobb-ID og batchnummer. Benyttes for å hente resultatet av et bestilt uttrekk. ```APIDOC ## GET v1/uttrekk/{jobbid}/batch/{batchnr} ### Description Henter et uttrekk basert på jobb-ID og batchnummer. Benyttes for å hente resultatet av et bestilt uttrekk. ### Method GET ### Endpoint v1/uttrekk/{jobbid}/batch/{batchnr} ### Parameters #### Path Parameters - **jobbid** (string) - Required - ID for uttrekksjobben - **batchnr** (string) - Required - Batchnummer for uttrekket ### Response #### Success Response (200) - Forventet responstid: Sammensatt (Hent batch + Bulkoppslag, < 10 s bulkoppslag) ### Rettighetspakker - OffentligMedHjemmel (for komplett uttrekk) - OffentligMedHjemmel, OffentligUtenHjemmel, PrivatUtenHjemmel (for tilpasset uttrekk) ### Bruksmønster Henter uttrekk etter bestilling. ``` -------------------------------- ### GET v1/personer/arkiv/{dokumentidentifikator} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter oppdaterte personopplysninger for en person med fødsels- eller D-nummer fra arkivet. ```APIDOC ## GET v1/personer/arkiv/{dokumentidentifikator} ### Description Henter oppdaterte personopplysninger for en person med fødsels- eller D-nummer fra arkivet. ### Method GET ### Endpoint v1/personer/arkiv/{dokumentidentifikator} ### Parameters #### Path Parameters - **dokumentidentifikator** (string) - Required - Identifikator for persondokumentet ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - OffentligMedHjemmel ### Bruksmønster Gir oppdatert personopplysninger for person med fødsels-, eller d-nummer. ``` -------------------------------- ### GET v1/personer/{personidentifikator} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter en person basert på personidentifikator (fødsels- eller D-nummer). Benyttes for enkeltoppslag, for eksempel direkte fra et fagsystem. ```APIDOC ## GET v1/personer/{personidentifikator} ### Description Henter en person basert på personidentifikator (fødsels- eller D-nummer). Benyttes for enkeltoppslag, for eksempel direkte fra et fagsystem. ### Method GET ### Endpoint v1/personer/{personidentifikator} ### Parameters #### Path Parameters - **personidentifikator** (string) - Required - Personidentifikator (fødsels- eller D-nummer) ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - OffentligMedHjemmel - Finans - OffentligUtenHjemmel - PrivatUtenHjemmel ### Bruksmønster Benyttes for enkeltoppslag, eks direkte fra et fagsystem. ``` -------------------------------- ### GET v1/hendelser/feedxsd Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter gjeldende XSD-dokument for feed. ```APIDOC ## GET v1/hendelser/feedxsd ### Description Henter gjeldende XSD-dokument for feed. ### Method GET ### Endpoint v1/hendelser/feedxsd ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - Ingen spesifisert ### Bruksmønster Gir gjeldende XSD-dokument for feed. ``` -------------------------------- ### GET v1/hendelser/{hendelsesidentifikator} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter et hendelsesdokument med detaljerte opplysninger om registerendringene som følger av hendelsen. ```APIDOC ## GET v1/hendelser/{hendelsesidentifikator} ### Description Henter et hendelsesdokument med detaljerte opplysninger om registerendringene som følger av hendelsen. ### Method GET ### Endpoint v1/hendelser/{hendelsesidentifikator} ### Parameters #### Path Parameters - **hendelsesidentifikator** (string) - Required - Identifikator for hendelsen ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - OffentligMedHjemmel ### Bruksmønster Gir hendelsesdokument med detaljerte opplysninger om registerendringene som følger av hendelsen. ``` -------------------------------- ### GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/feed/ Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Retrieves a feed of events from the event list, starting from a given sequence number. The sequence number is provided as a query parameter. ```APIDOC ## GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/feed/ ### Description Retrieves a feed of events from the event list, starting from a given sequence number. ### Method GET ### Endpoint `https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/feed/` ### Parameters #### Query Parameters - **seq** (integer) - Required - The sequence number to start the feed from. ### Request Example `https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/feed/?seq=1` ### Response #### Success Response (200) Returns a feed of events. ### Headers - **Accept** - Optional - Desired data format: `application/json` (default) or `application/xml`. - **If-None-Match** - Optional - Set to the ETag header from the last response to enable conditional requests. ``` -------------------------------- ### GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/xsd Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Retrieves the XSD schema for the event list. ```APIDOC ## GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/xsd ### Description Retrieves the XSD schema for the event list. ### Method GET ### Endpoint `https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/xsd` ### Response #### Success Response (200) Returns the XSD schema. ### Headers - **Accept** - Optional - Desired data format: `application/json` (default) or `application/xml`. ``` -------------------------------- ### GET v1/personer/soek Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Søker etter personer og returnerer en treffliste. Benyttes når søket gir mer enn ett treff, og etterfølges av bulkoppslag på identifikasjonsnummer i trefflisten. ```APIDOC ## GET v1/personer/soek ### Description Søker etter personer og returnerer en treffliste. Benyttes når søket gir mer enn ett treff, og etterfølges av bulkoppslag på identifikasjonsnummer i trefflisten. ### Method GET ### Endpoint v1/personer/soek ### Response #### Success Response (200) - Forventet responstid: < 2 s ### Rettighetspakker - OffentligMedHjemmel - Finans - OffentligUtenHjemmel - PrivatUtenHjemmel ### Bruksmønster Søk med mer enn et treff. Etterfølges av bulkoppslag på identifikasjonsnummer i treffliste. ``` -------------------------------- ### GET v1/hendelser/feed Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter hendelseslisten for å lytte på nye hendelser. Etterfølges av bulkoppslag på Hendelsesdokument og Persondokument. ```APIDOC ## GET v1/hendelser/feed ### Description Henter hendelseslisten for å lytte på nye hendelser. Etterfølges av bulkoppslag på Hendelsesdokument og Persondokument. ### Method GET ### Endpoint v1/hendelser/feed ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - OffentligMedHjemmel - Finans - OffentligUtenHjemmel - PrivatUtenHjemmel - Presse - Privat ### Bruksmønster Lytte på nye hendelser som påfølges av bulkoppslag på Hendelsesdokument og Persondokument. Feks hvert minutt. ``` -------------------------------- ### GET /folkeregisteret/offentlig-med-hjemmel/api/v1/personer/entydigsoek Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/oppslag/ Utfører et entydig søk etter en person basert på ulike søkekriterier. Krever at søket er entydig, og returnerer et komplett persondokument ved treff. ```APIDOC ## GET /folkeregisteret/offentlig-med-hjemmel/api/v1/personer/entydigsoek ### Description Utfører et entydig søk etter en person basert på ulike søkekriterier. Krever at søket er entydig, og returnerer et komplett persondokument ved treff. ### Method GET ### Endpoint https://folkeregisteret-api-konsument.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/personer/entydigsoek ### Parameters #### Query Parameters - **foedselsdato** (string) - Optional - Fødselsdato i format YYYYMMDD. Eksempel: 19551228 - **navn** (string) - Required - Navn (fornavn og etternavn). Eksempel: Arne gran - **postnummer** (string) - Optional - Postnummer. Eksempel: 5089 - **adressenavn** (string) - Optional - Gatenavn, eller minst 3 tegn fra begynnelsen av det. Eksempel: adolph bergs vei - **husnummer** (string) - Optional - Husnummer, kreves hvis adressen har husnummer og/eller bokstav. Eksempel: 14 - **soekFonetisk** (boolean) - Optional - Angir om søket skal være fonetisk. Eksempel: true - **identifikasjonsnummer** (string) - Optional - Fødselsnummer eller D-nummer. Eksempel: 13108138812 - **utenlandskpersonidentifikasjon** (string) - Optional - Utenlandsk personidentifikasjon med landkode. Kun for rettighetspakkene Offentlig med hjemmel og Utsteder av elektronisk identitetsbevis. Eksempel: ARG-8766523769 - **legitimasjonsdokument** (string) - Optional - Legitimasjonsdokument med landkode. Kun for rettighetspakkene Offentlig med hjemmel og Utsteder av elektronisk identitetsbevis. Eksempel: DNK-7545367 - **utlendingsmyndighetenesIdentifikasjonsnummer** (string) - Optional - Utlendingsmyndighetenes identifikasjonsnummer. Kun for rettighetspakken Offentlig med hjemmel. Eksempel: 87676437682 ### Request Example ``` curl -k -v -X GET "https://folkeregisteret-api-konsument.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/personer/entydigsoek?foedselsdato=19551228&navn=Arne%20gran&postnummer=5089&adressenavn=adolph%20bergs%20vei&husnummer=14&soekFonetisk=true" -H 'Content-Type: application/json' -H "Authorization: Bearer $(ditt_token)" ``` ### Response #### Success Response (200) - **person** (object) - Komplett og oppdatert persondokument for den entydige personen. #### Response Example (Not provided in source) ### Error Handling - Søk med opplysninger som matcher flere enn én person vil resultere i feilmelding. ``` -------------------------------- ### GET /folkeregisteret/tilbakemelding/api/{versjon}/hendelser Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/tilbakemelding/ Retrieves a list of feedback events (tilbakemeldinger) matching the query in the URL. The response contains a list of feedback items when status code 200 is returned. Status code 304 indicates no new events since the last call when using the If-None-Match header. ```APIDOC ## GET /folkeregisteret/tilbakemelding/api/{versjon}/hendelser ### Description Retrieves a list of feedback events (tilbakemeldinger) matching the query in the URL. The response contains a list of feedback items when status code 200 is returned. Status code 304 indicates no new events since the last call when using the If-None-Match header. ### Method GET ### Endpoint /folkeregisteret/tilbakemelding/api/{versjon}/hendelser ### Parameters #### Path Parameters - **versjon** (string) - Required - API version identifier. #### Headers - **Accept** (string) - Optional - Specifies the response format. Must be one of 'application/atom+xml', 'application/xml', or 'application/json'. If not provided, the default may apply. - **If-None-Match** (string) - Optional - ETag value from a previous response. If it matches the current ETag, a 304 Not Modified response is returned. ### Response #### Success Response (200) Returns a list of feedback objects. Each object contains: - **title** (string) - Title of the feedback event. - **id** (string) - Unique identifier of the feedback event. - **updated** (string) - Timestamp of the last update in ISO 8601 format. - **hendelseinfo** (object) - Contains details about the event. May include: - **sak** (object) - Case information with fields: - **saksnummer** (string) - Case number. - **opprettet** (string) - Creation timestamp. - **avsendersSaksreferanse** (string) - Sender's case reference. - **meldingsreferanse** (object) - Message reference with fields: - **avsendersMeldingsidentifikator** (string) - Sender's message identifier. - **folkeregisterReferanse** (string) - Folkeregister reference. - **sakTilManuellBehandling** (object) - Information for manual processing, with fields: - **saksfrist** (string) - Deadline for the case. - **begrunnelse** (string) - Reason for manual processing. - **saksbeslutning** (object) - Decision information, with fields: - **beslutning** (string) - Decision outcome (e.g., 'godkjent'). - **beslutningstidspunkt** (string) - Decision timestamp. - **skalTildeleDNummer** (object) - D-number assignment details, with fields: - **dNummer** (string) - Assigned D-number. - **registreringstidspunkt** (string) - Registration timestamp. - **gyldighetstidspunkt** (string) - Validity timestamp. - **tildeltDnummerAvvikerFraFoedselsdato** (boolean) - Indicates if the assigned D-number differs from the birth date. #### Response Example ```json [ { "title": "Hendelse i sak", "id": "5", "updated": "2016-12-21T09:01:34.496Z", "hendelseinfo": { "sak": { "saksnummer": "117152", "opprettet": "2016-12-21T09:01:30.687Z", "avsendersSaksreferanse": "201216/fil-7-wf", "meldingsreferanse": { "avsendersMeldingsidentifikator": "2112116 - avviksmerknad om dublett og merknad om forkortet navn", "folkeregisterReferanse": "ab567940-cfd6-4a0d-aec6-44999e5aa4b1" } }, "sakTilManuellBehandling": { "saksfrist": "2016-12-26", "begrunnelse": "muligDublett" } } }, { "title": "Hendelse i sak", "id": "6", "updated": "2016-12-21T09:02:03.884Z", "hendelseinfo": { "sak": { "saksnummer": "117152", "opprettet": "2016-12-21T09:01:30.687Z", "avsendersSaksreferanse": "201216/fil-7-wf", "meldingsreferanse": { "avsendersMeldingsidentifikator": "2112116 - avviksmerknad om dublett og merknad om forkortet navn", "folkeregisterReferanse": "ab567940-cfd6-4a0d-aec6-44999e5aa4b1" } }, "saksbeslutning": { "beslutning": "godkjent", "beslutningstidspunkt": "2016-12-21T09:02:03.857Z", "skalTildeleDNummer": { "dNummer": "70107300943", "registreringstidspunkt": "2016-12-20T23:00:00Z", "gyldighetstidspunkt": "2016-12-20T23:00:00Z", "tildeltDnummerAvvikerFraFoedselsdato": false } } } }, { "title": "Hendelse i sak", "id": "7", "updated": "2016-12-21T09:03:48.546Z", "hendelseinfo": { "sak": { "saksnummer": "117155", "opprettet": "2016-12-21T09:03:45.379Z", "avsendersSaksreferanse": "201216/fil-8-wf", "meldingsreferanse": { "avsendersMeldingsidentifikator": "2112116 - avviksmerknad om dublett og merknad om forkortet navn", "folkeregisterReferanse": "57471707-69cf-4759-b549-3d3e2d2873fa" } }, "sakTilManuellBehandling": { "saksfrist": "2016-12-26", "begrunnelse": "muligDublett" } } } ] ``` #### Success Response (304) Returned when the If-None-Match header matches the current ETag, indicating no new events since the last call. No body is returned. #### Error Responses If the status code is neither 200 nor 304, an error structure is returned: ```json { "kode": "FREG-001", "melding": "Feil i tjenesten. Vennligst prøv igjen seinere." } ``` | HTTP Statuskode | Forklaring | | --- | --- | | 401 | Autentiseringsinformasjon mangler. | | 403 | Virksomheten er autentisert men mangler autorisasjon for den angitte tjenesten. | | 404 | Feil uri brukt. | | 406 | Oppgitt Accept-header inneholder ikke 'application/atom+xml', 'application/xml' eller 'application/json'. | | 429 | For mange kall er gjort på for kort tid. Vent i minimum antall ms. angitt i Retry-After-header før neste request utføres. | | 500 | Feil i tjenesten. Vennligst prøv igjen seinere. | ``` -------------------------------- ### GET v1/hendelser/siste/sekvensnummer Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Henter siste sekvensnummer (nyeste hendelse) for hendelseslisten. ```APIDOC ## GET v1/hendelser/siste/sekvensnummer ### Description Henter siste sekvensnummer (nyeste hendelse) for hendelseslisten. ### Method GET ### Endpoint v1/hendelser/siste/sekvensnummer ### Response #### Success Response (200) - Forventet responstid: < 500 ms ### Rettighetspakker - OffentligMedHjemmel - Finans - OffentligUtenHjemmel - PrivatUtenHjemmel - Presse - Privat ### Bruksmønster Gir siste sekvensnummer (nyeste hendelse) for hendelseslisten. ``` -------------------------------- ### curl eksempel på entydig søk Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/oppslag/ Eksempel på entydig søk med curl mot oppslagstjenesten. Krever et gyldig token (ditt_token) og bruker GET med query-parametere for fødselsdato, navn, postnummer, adresse og fonetisk søk. ```bash $ curl -k -v -X GET "https://folkeregisteret-api-konsument.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/personer/entydigsoek?foedselsdato=19551228&navn=Arne%20gran&postnummer=5089&adressenavn=adolph%20bergs%20vei&husnummer=14&soekFonetisk=true" -H 'Content-Type: application/json' -H "Authorization: Bearer $(ditt_token)" ``` -------------------------------- ### GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/{hendelseId} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Retrieves a single event from the event list by its unique identifier (UUID). ```APIDOC ## GET /folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/{hendelseId} ### Description Retrieves a single event from the event list by its unique identifier (UUID). ### Method GET ### Endpoint `https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/{hendelseId}` ### Parameters #### Path Parameters - **hendelseId** (UUID) - Required - The unique identifier of the event. ### Request Example `https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/7d9c19b1-4125-4968-b4dc-09cbaf3ac11f` ### Response #### Success Response (200) Returns the event document. ### Headers - **Accept** - Optional - Desired data format: `application/json` (default) or `application/xml`. ``` -------------------------------- ### GET /folkeregisteret/tilbakemelding/api/{versjon}/hendelser Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/tilbakemelding/ Henter en side med hendelser fra tilbakemeldingsfeedet. Bruk sekvensnummer for å navigere gjennom feeden, og spesifiser retning (nyere/eldre) og sidestørrelse. ```APIDOC ## GET /folkeregisteret/tilbakemelding/api/{versjon}/hendelser ### Description Henter en side med hendelser fra tilbakemeldingsfeedet. Bruk sekvensnummer for å navigere gjennom feeden, og spesifiser retning (nyere/eldre) og sidestørrelse. ### Method GET ### Endpoint `GET {miljø}/folkeregisteret/tilbakemelding/api/{versjon}/hendelser?seq={startsekvensnummer}&direction={nyere/eldre}&pageSize=100` ### Parameters #### Query Parameters - **seq** (integer) - Required - Startsekvensnummer for feeden. - **direction** (string) - Required - Retning for navigasjon: `nyere` eller `eldre`. - **pageSize** (integer) - Optional - Antall hendelser per side. Eksempel: 100. ### Headers - **Accept** (string) - Required - Ønsket dataformat: `application/json` eller `application/xml`. - **If-None-Match** (string) - Optional - Sett til ETag-verdien fra siste respons for å få 304 Not Modified hvis innholdet er uendret. ### Request Example ```bash curl -k -v -X GET --cert datakonsument.cer --key datakonsument.key "https://folkeregisteret-api-produsent.sits.no/folkeregisteret/tilbakemelding/api/v2/hendelser?seq=1&direction=nyere&pageSize=100" ``` ### Response #### Success Response (200) - **Feed** (Atom feed) - Hendelsesfeed i henhold til Atom-spesifikasjonen. Innholdet kan inneholde følgende kontrakter: - HendelserISakOmFolkeregistrering_v1 - HendelserISakOmDNummerRekvisisjon_v3 - HendelserISakOmEndringAvDNummerPerson_v1 #### Response Example (ikke gitt i kilden) ### Error Handling - **304 Not Modified** - Returneres når If-None-Match matcher gjeldende ETag. ``` -------------------------------- ### GET /v1/personer/{id}?part=historikk&part=navn&part=bostedsadresse Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/dataminimering/ Eksempel på bruk av part-parameteren for å begrense oppslaget til spesifikke entiteter. Dette returnerer gjeldende og historiske oppføringer for navn og bostedsadresse, samt identifikasjonsnummer med mindre rettighetspakken er privat eller presse. ```APIDOC ## GET /v1/personer/{id}?part=historikk&part=navn&part=bostedsadresse ### Description Eksempel på oppslag med part-parameter for å begrense resultatet til spesifikke entiteter. Returnerer gjeldende og historiske oppføringer for navn og bostedsadresse, samt identifikasjonsnummer (med mindre rettighetspakken er privat eller presse). ### Method GET ### Endpoint /v1/personer/{id}?part=historikk&part=navn&part=bostedsadresse ### Parameters #### Path Parameters - **id** (string) - Required - Personidentifikator (fødselsnummer eller D-nummer) #### Query Parameters - **part** (string) - Required - Spesifiserer hvilke entiteter som skal inkluderes i oppslaget. Kan angis flere ganger. Eksempel: part=historikk&part=navn&part=bostedsadresse ### Response #### Success Response (200) - Returnerer gjeldende og historiske oppføringer for de spesifiserte entitetene (navn og bostedsadresse). - Identifikasjonsnummer returneres også, med mindre rettighetspakken er privat eller presse. #### Response Example { "navn": [...], "bostedsadresse": [...], "identifikasjonsnummer": "12345612345" } ``` -------------------------------- ### GET hendelser endepunkt Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/tilbakemelding/ Endepunkt for å hente hendelser fra tilbakemeldingstjenesten. Parametere: seq (startsekvensnummer), direction (nyere/eldre), pageSize. ```http GET {miljø}/folkeregisteret/tilbakemelding/api/{versjon}/hendelser?seq={startsekvensnummer}&direction={nyere/eldre}&pageSize=100 ``` -------------------------------- ### Algoritme for uttrekksflyt Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/uttrekk/ Pseudokode som viser flyten for å bestille uttrekk, hente batcher, og behandle persondokumenter. Den inkluderer en while-løkke som fortsetter til batchen er tom. ```pseudocode jobbid = bestillUttrekk(sekvensnummer) batchteller = 0 batch = hentResultat(jobbid, batchteller) while (batch.resultat > 0) { persondokumenter = hentPersondokumenter(batch) // behandle persondokumenter batch = hentResultat(jobbid, ++batchteller) } ``` -------------------------------- ### POST {miljø}/folkeregisteret/mottak/api/{ressurs} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/mottak/ Sender inn et dokument til Folkeregisteret. Dokumentet sendes som body i forespørselen, og formatet skal være UTF-8. ```APIDOC ## POST {miljø}/folkeregisteret/mottak/api/{ressurs} ### Description Sender inn et dokument til Folkeregisteret. Dokumentet sendes som body i forespørselen, og formatet skal være UTF-8. ### Method POST ### Endpoint `{miljø}/folkeregisteret/mottak/api/{ressurs}` ### Parameters #### Path Parameters - **miljø** (string) - Required - Miljøet som tjenesten kjører i (f.eks. produksjon eller test). - **ressurs** (string) - Required - Identifikator for hvilken type dokument som sendes inn. Tilgjengelige ressurser er: - `rekvisisjon_av_dnummer` (utgått) - `rekvisisjon_av_dnummer_v3` (utgått) - `rekvisisjon_av_dnummer_v4` (produksjon) - `rekvisisjon_av_dnummer_v4.vedlegg` (produksjon) - `rekvisisjon_av_dnummer_v5` (produksjon) - `rekvisisjon_av_dnummer_v5.vedlegg` (produksjon) - `doedsfall_v1` (produksjon/test) - `annullering_av_doedsfall_v1` (produksjon/test) - `endring_av_dnummerperson_v2` (produksjon) - `endring_av_dnummerperson_v3` (produksjon) - `foedsel_v1` (produksjon) - `kontaktopplysninger_doedsbo_v1` (test) - `separasjon_v1` (test) - `skilsmisse_v1` (test) #### Request Body Dokumentet som skal sendes inn, i henhold til kontrakten (XSD) for den valgte ressursen. Formatet skal være UTF-8. ### Request Example ```xml ``` ### Response #### Success Response (200) - **tilbakemeldingshendelse** (string) - Hendelse som returneres som kvittering for mottatt dokument. Avhenger av ressurs og versjon. #### Response Example ```json { "hendelse": "HendelserISakOmFolkeregistrering_v1" } ``` ``` -------------------------------- ### Bulkoppslag på hendelsesdokumenter Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Eksempel på POST-forespørsel for bulkoppslag på flere hendelsesdokumenter. Krever gyldig token og Content-Type header satt til application/json. ```bash $ curl -k -v -X POST -d '{"dokumentidentifikator": ["f5446d4445738d5a3dad02276daf8a1f","f5446d4445738d5a3dad02276daf8a1f"]}' -H "Content-Type: application/json" "https://folkeregisteret-api-konsument.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/bulkoppslag/" -H "Authorization: Bearer $(ditt_token)" ``` -------------------------------- ### POST v1/personer/bulkoppslag Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Utfører bulkoppslag på flere personer samtidig. Benyttes når en skal slå opp på mer enn én person, for eksempel relasjonene til en tidligere hentet person eller endrede personer på hendelsesliste. ```APIDOC ## POST v1/personer/bulkoppslag ### Description Utfører bulkoppslag på flere personer samtidig. Benyttes når en skal slå opp på mer enn én person, for eksempel relasjonene til en tidligere hentet person eller endrede personer på hendelsesliste. ### Method POST ### Endpoint v1/personer/bulkoppslag ### Response #### Success Response (200) - Forventet responstid: < 10 s (øker med antall oppslag i kallet) ### Rettighetspakker - OffentligMedHjemmel - Finans - OffentligUtenHjemmel - PrivatUtenHjemmel ### Bruksmønster Benyttes dersom en skal slå opp på mer enn en person, eks relasjonene til en tidligere hentet person eller endrede personer på hendelsesliste. Merk at responstiden øker sammen med antall oppslag i kallet. ``` -------------------------------- ### Curl-kommando for å teste tjenesten Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Eksempel på curl-kommando som benytter HEAD-forespørsel for å teste tjenesten. Krever et gyldig token i Authorization-headeren. ```bash curl -v -k -X HEAD 'https://folkeregisteret-api-konsument.sits.no/folkeregisteret/api/privat/v1/hendelser/feed' -H 'accept: application/json' -H 'Content-Type: application/json' -H "Authorization: Bearer $(ditt_token)" ``` -------------------------------- ### POST v1/personer/bulkoppslag/arkiv Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/ytelse-og-responstider/ Utfører bulkoppslag på persondokumenter etter lytting på hendelsesliste. ```APIDOC ## POST v1/personer/bulkoppslag/arkiv ### Description Utfører bulkoppslag på persondokumenter etter lytting på hendelsesliste. ### Method POST ### Endpoint v1/personer/bulkoppslag/arkiv ### Response #### Success Response (200) - Forventet responstid: < 10 s ### Rettighetspakker - OffentligMedHjemmel ### Bruksmønster Tilhørende oppslag på persondokumenter etter lytting på hendelsesliste. ``` -------------------------------- ### curl-kommando for å teste tjenesten Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/tilbakemelding/ Eksempel på curl-kommando som benyttes for å teste tjenesten. Krever sertifikat og nøkkel (datakonsument.cer og datakonsument.key). ```bash $ curl -k -v -X GET --cert datakonsument.cer --key datakonsument.key "https://folkeregisteret-api-produsent.sits.no/folkeregisteret/tilbakemelding/api/v2/hendelser?seq=1&direction=nyere&pageSize=100" ``` -------------------------------- ### POST /folkeregisteret/mottak/api/{ressurs} Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/mottak/ Sender en melding til Folkeregisteret. Endepunktet aksepterer XML-meldinger i henhold til spesifiserte XSD-er og returnerer en bekreftelse med referanse. ```APIDOC ## POST /folkeregisteret/mottak/api/{ressurs} ### Description Sender en melding til Folkeregisteret. Endepunktet aksepterer XML-meldinger i henhold til spesifiserte XSD-er og returnerer en bekreftelse med referanse. ### Method POST ### Endpoint /folkeregisteret/mottak/api/{ressurs} ### Parameters #### Path Parameters - **ressurs** (string) - Required - Identifikator for meldingstypen, f.eks. `melding_om_unik_v1`. #### Request Body - **XML-melding** (string) - Required - XML-melding i henhold til gjeldende XSD. ### Request Example ``` curl -X POST 'https://folkeregisteret-api-produsent.sits.no/folkeregisteret/mottak/api/melding_om_unik_v1' -H "Authorization: Bearer $(ditt_token)" -d "$(xml_melding)" ``` ### Response #### Success Response (202) - **meldingMottatt** (object) - Bekreftelse på mottatt melding. - **folkeregisterReferanse** (string) - Referanse fra Folkeregisteret. - **avsendersMeldingsidentifikator** (string) - Avsenders meldingsidentifikator. #### Response Example ```xml 47956f5b-fa1e-447d-a62d-b6714bc1f120 unik-3efaf50b2a19 ``` ### Error Responses - **400** - Innsendt melding er ikke gyldig XML, validerer ikke iht. XSD eller informasjon sendt i Authorization-header er ugyldig. - **401** - Autentiseringsinformasjon mangler. - **403** - Virksomheten er autentisert men mangler autorisasjon for den angitte tjenesten. - **404** - Feil uri brukt. - **406** - Oppgitt Accept-header inneholder ikke 'application/xml'. - **429** - For mange kall er gjort på for kort tid. Vent i minimum antall ms. angitt i Retry-After-header før neste request utføres. - **500** - Feil i tjenesten. Vennligst prøv igjen seinere. #### Error Response Example ```xml 403 WARNING ske.folkeregister.mottak.infrastructure.exceptions.KonsumentManglerTilgangException Produsent har ikke tilgang til å sende inn D_NUMMER_REKVISISJON_V4 ``` ``` -------------------------------- ### Statuskode 304 Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ Beskrivelse av statuskode 304 (not modified) som returneres når If-None-Match-headeren er lik ETag for etterspurte ressurs. ```APIDOC ### Statuskode 304 Statuskode 304 (_not modified_) returneres hvis kallet til tjenesten inkluderte headeren **If-None-Match** og denne er lik den aktuelle ETag for etterspurte ressurs. Det betyr at det ikke er kommet noen nye innslag på feeden siden forrige kall. ``` -------------------------------- ### Curl test with virksomhetssertifikat Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/mottak/ Curl command to test the service using a virksomhetssertifikat. Uses -k to skip certificate verification and -v for verbose output. ```bash $ curl -k -v -X HEAD --cert datakonsument.cer --key datakonsument.key "https://folkeregisteret-api-produsent.sits.no/folkeregisteret/mottak/api/rekvisisjon_av_dnummer_v4" ``` -------------------------------- ### Oppslag på XSD URL Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ URL for å hente XSD-skjemaet for hendelser. ```text https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/xsd ``` -------------------------------- ### Oppslag i hendelsesliste URL Source: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/hendelsesliste/ URL for å slå opp i hendelseslisten med sekvensnummer 1. ```text https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/offentlig-med-hjemmel/api/v1/hendelser/feed/?seq=1 ```