Gå til hovedindhold
Webservice / Serviceplatformen
CprLookupService_FamiliePlus

Formål

Servicen kan ved en forespørgsel på et personnummer returnere fx stamdata, adresse og indrapportering.

Beskrivelse

Servicen tager et personnummer som parameter og returnerer oplysninger om personens:
- Stamdata: Bl.a. adresseringsnavn, c/o-navn, beskyttelsesoplysninger, status på personen, køn, fornavn, mellemnavn, efternavn, slægtsnavn, personnummer og fødedato
- Adresse: Bl.a. kommunekode, postnummer, bynavn, vejkode, bygningsnummer, husnummer, etage, sidedør, lokalitet, standardadresse, udlandsadresse og udrejselandekode
- Indrapportering/Administration: Bl.a. indrapporteringsdatoer, indrapporteringsmyndigheder og tidligere navne markering

For de relaterede personer returneres kun:
- Adresseringsnavn (ADRNVN)
- Status (CNVN_STATUS)
- Postdistrikt (CPSN_POSTDISTTXT)
- Postnummer (CPST_POSTNR)
- Familierelation (FAMMRK)
- Fødedato/CPR-nummer (PNT_FOEDDATO)
- Standardadresse (STADR)

Yderligere oplysninger om de relaterede personer må derfor hentes gennem et nyt opslag på pågældende person.

Servicen er baseret på CPR's familie. På samme måde som hos CPR-registret returneres et svar med maksimalt 20 personer ad gangen. Skulle søgningen resultere i et svar med flere end 20 personer, skal servicen kaldes igen for at hente de næste 20 personer i svaret.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat- InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: a34cf599-26e4-4609-bfbd-2490d3d1c3ab

EntityId: http://cpr.serviceplatformen.dk/service/familie-plus/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: a34cf599-26e4-4609-bfbd-2490d3d1c3ab

EntityId: http://cpr.serviceplatformen.dk/service/familie-plus/2

Webservice / Serviceplatformen
CprLookupService_Stam

Formål

Servicen giver kommunale fagsystemer mulighed for at fremsøge stamoplysninger for en person.

Servicen understøtter, at der ved opslag på et personnummer modtages information om personens stamdata og adresse.

Beskrivelse

Servicen tager et personnummer som parameter og returnerer oplysninger om personens stamdata og adresse:
- Stamdata: Bl.a. adresseringsnavn, status, køn, fødedato, gældende personnummer samt navne-/adressebeskyttelse
- Adresse: Bl.a. standardadresse, bygningsnummer, c/o-navn, lokalitet, vejkode, kommunekode samt udrejse- eller indrejseadresse og -land

Servicen er baseret på CPR's stam. På samme måde som hos CPR-registret, returneres et svar med maksimalt 20 personer ad gangen. Skulle søgningen resultere i et svar med flere end 20 personer, skal servicen kaldes igen for at hente de næste 20 personer i svaret.

Fra version 1.1 returneres GCTP xml´en i namespacet: http://www.cpr.dk.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: 7ae36552-730c-4b0a-9742-309e97b12197

EntityId: http://cpr.serviceplatformen.dk/service/stam/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: 7ae36552-730c-4b0a-9742-309e97b12197

EntityId: http://cpr.serviceplatformen.dk/service/stam/2

Webservice / Serviceplatformen
CprLookupService_StamPlus

Formål

Servicen giver anvendersystemer mulighed for at fremsøge stamoplysninger for en person.

Servicen understøtter, at der ved opslag på et personnummer modtages information om personens stamdata, adresseinformation, vejadresseringsnavn og postdistrikt.

Beskrivelse

Servicen returnerer oplysninger om personens:
- Stamdata: Bl.a. adresseringsnavn, status, køn, fødedato, gældende personnummer samt navne/adressebeskyttelse
- Adresse: Bl.a. standardadresse, bygningsnummer, c/o-navn, vejadresseringsnavn, lokalitet, vejkode, postdistrikt, kommunekode samt udrejse- eller indrejseadresse og -land

Servicen er baseret på CPR's stam. På samme måde som hos CPR-registeret, returneres et svar med maksimalt 20 personer ad gangen. Skulle søgningen resultere i et svar med flere end 20 personer, skal servicen kaldes igen for at hente de næste 20 personer i svaret.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certificat - InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: 7baec3a5-26a5-4922-80fd-37f3bad3dfcb

EntityId: http://cpr.serviceplatformen.dk/service/stam-plus/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: 7baec3a5-26a5-4922-80fd-37f3bad3dfcb

EntityId: http://cpr.serviceplatformen.dk/service/stam-plus/2

Webservice / Serviceplatformen
CPRQueryService

Formål

Servicen giver mulighed for at fremsøge lister over personer ud fra udvalgte søgekriterier.

Beskrivelse

Servicen indeholder en søgefunktion, som benytter søgesproget SOLR. Det er muligt at søge på udvalgte parametre, fx navn, fødselsdato, personnummer, vejnavn, vejkode eller adresseUUID. Mindst en parameter skal være angivet.

Anvendersystemet kalder servicen med en søgestreng, som skal være en syntaktisk korrekt formateret SOLR-querystring. SOLR understøtter komplekse forespørgsler både i forhold til constraints, fritekst og wildcardsøgninger, og søgninger på tværs af flere felter. Anvendersystemet kan også angive en parameter i forespørgslen med hvor mange resultater, der returneres i svaret.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPR/Query/3

UUID: d9e10e40-1f7f-11ec-b3a3-4b927cf8dd20

EntityId: http://cpr.serviceplatformen.dk/service/query/3

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPR/Query/3

UUID: d9e10e40-1f7f-11ec-b3a3-4b927cf8dd20

EntityId: http://cpr.serviceplatformen.dk/service/query/3

Formål

Servicen giver mulighed for at fremsøge lister over personer ud fra udvalgte søgekriterier.

Beskrivelse

Servicen indeholder en søgefunktion, som understøtter samme søgeparametre som ADRSOG1 fra CPR, dog udvidet med fødselsdato. Mindst et parameter af typen navn, fødselsdato, personnummer, vejnavn eller vejkode skal være angivet.

Søgningen understøtter fleksibel søgning på kombinationer af CPR, Navn, Fødselsdato, Køn, Adresse, Vejnavn, Interval af husnumre, Husnumre, Etage, Side/dørnummer, Postnummer, By, Distrikt, Kommune, Vejkode samt Historisk adresser.

Anvendersystemet kalder CPR QueryService med et enkelt parameter, som skal være en syntaktisk korrekt formateret SOLR querystring. SOLR understøtter komplekse forespørgsler både i forhold til constraints, fritekst og wildcardsøgninger, og søgninger på tværs af flere felter. Anvendersystemet kan også angive, hvor mange resultater der returneres i svaret som en parameter i forespørgslen.

Servicen er baseret på CPR's ADRSOG1.

Servicen er udstillet med følgende sikkerhedsmodel:
- SAML-Token

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPR/Query/2

UUID: 3f9751cd-45a7-430a-b5e6-fc6122c1dd22

EntityId: http://cpr.serviceplatformen.dk/service/query/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPR/Query/2

UUID: 3f9751cd-45a7-430a-b5e6-fc6122c1dd22

EntityId: http://cpr.serviceplatformen.dk/service/query/2

Webservice / Serviceplatformen
CprService

Formål

Servicen giver mulighed for at tilgå CPR-data, der findes i CPR-registeret.

Beskrivelse

Servicen giver mulighed for at tilgå de CPR-services, der udstilles af CPR-kontoret (myndighedsregister og vejregister) og implementerer services, der udstilles af CPR til offentlige myndigheder.

Servicen er af typen gennemstilling, og fungerer således, at anvendersystemet kontakter Serviceplatformen med en forespørgsel, hvorefter Serviceplatformen videresender forespørgslen til kildesystemet. Serviceplatformen indkapsler dermed kildesystemet, så anvendersystemet ikke påvirkes, hvis der fx sker ændringer i kildesystemet.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRService/CPRService/1

UUID: 8ee213c7-25a9-11e2-8770-d4bed98c63db

EntityId: http://cpr.serviceplatformen.dk/service/opslag/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRService/CPRService/1

UUID: 8ee213c7-25a9-11e2-8770-d4bed98c63db

EntityId: http://cpr.serviceplatformen.dk/service/opslag/1

Webservice / Serviceplatformen
CprSubscriptionService

Formål

Servicen giver mulighed for, at kommunens fagsystem kan abonnere på ændringer i CPR-data for de personer, som kommunen vælger at opsætte hændelsesabonnement på.

Nyt i denne version

Version 2.0 indeholder alle felter, som modtages fra CPR-kontoret inkl. de ovenfor nævnte nye felter AdresseUUID, Delvis værgemål og Delt bopæl.

Beskrivelse

Bemærk, at denne version er under udvikling.

Servicen bygger på et fuld udtræk fra CPR-kontoret dateret 12. maj 2022 samt de ændringer, der er løbet på siden da.

Ændringsudtræk sendes fra CPR-kontoret på hverdage, hvilket betyder, at man som modtager kan forvente at modtage filer fra Serviceplatformen med ændrede persondata dagligt. Der leveres persondata med tilhørende 99 års historik.
Filerne leveres til kommunens fagsystem via fagsystemets SFTP-mappe på Serviceplatformen. For anvendelse af servicen er det derfor en forudsætning, at anvendersystemet er tilknyttet Serviceplatformens SFTP med filudvekslingstypen simpel.

CPR Abonnementet sættes op ved brug af ét eller flere filtre:
- Alder: Med dette filter modtages alle ændringer for personer, som har en alder inden for det angivne aldersinterval - eksempelvis alle personer under 18 år eller alle personer over 65 år.
- Kommunekode: Med dette filter modtages alle ændringer for personer, som er bosat inden for den/de angivne kommunekode(r), herunder tilflyttere.
- CPR-numre: Med dette filter modtages alle ændringer for personer med de angivne CPR-numre.
- Hændelseskoder: Med dette filter modtages alle CPR-data for personer, hvor der er sket ændringer inden for valgte hændelseskode – eksempelvis for alle dødsfald eller navneændringer.
- Ingen filtre: Med dette filter modtages alle ændrede CPR-data for alle personer.

Det er kommunens ansvar at sikre, at der foreligger et sagligt behov for modtagelse af CPR-data for de personer, som er specificeret i ændringsfiltrene. Ligeledes er det kommunens ansvar at sikre, at kommunens fagsystem ikke modtager CPR-data for personer, hvor der ikke længere foreligger et sagligt behov.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InnovationContext

Formål

Servicen giver mulighed for, at kommunens fagsystem kan abonnere på ændringer i CPR-data for de personer, som kommunen vælger at opsætte hændelsesabonnement på.

Beskrivelse

Ændringsudtræk sendes fra CPR-kontoret på hverdage, hvilket betyder, at man som modtager kan forvente at modtage filer fra Serviceplatformen med ændrede persondata dagligt. Der leveres persondata med tilhørende 99 års historik. Filerne leveres til kommunens fagsystem via fagsystemets SFTP-mappe på Serviceplatformen. For anvendelse af servicen er det derfor en forudsætning, at anvendersystemet er tilknyttet Serviceplatformens SFTP med filudvekslingstypen simpel.

CPR Abonnementet sættes op ved brug af ét eller flere filtre:
- Alder: Med dette filter modtages alle ændringer for personer, som har en alder inden for det angivne aldersinterval - eksempelvis alle personer under 18 år eller alle personer over 65 år
- Kommunekode: Med dette filter modtages alle ændringer for personer, som er bosat inden for den/de angivne kommunekoder, herunder tilflyttere
- CPR-numre: Med dette filter modtages alle ændringer for personer med de angivne CPR-numre
- Hændelseskoder: Med dette filter modtages alle CPR-data for personer, hvor der er sket ændringer inden for valgte hændelseskode – eksempelvis for alle dødsfald eller navneændringer
- Ingen filtre: Med dette filter modtages alle ændrede CPR-data for alle personer

Det er kommunens ansvar at sikre, at der foreligger et sagligt behov for modtagelse af CPR-data for de personer, som er specificeret i ændringsfiltrene. Ligeledes er det kommunens ansvar at sikre, at kommunens fagsystem ikke modtager CPR-data for personer, hvor der ikke længere foreligger et sagligt behov.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Serviceplatformen har valgt at etablere et lokalt CPR-replika af performancemæssige og økonomiske årsager. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InnovationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRSubscription/CPRSubscription/1/

UUID: 9cdccc2f-3243-11e2-8fef-d4bed98c5934

EntityId: http://cpr.serviceplatformen.dk/service/abonnement/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRSubscription/CPRSubscription/1/

UUID: 9cdccc2f-3243-11e2-8fef-d4bed98c5934

EntityId: http://cpr.serviceplatformen.dk/service/abonnement/1

Webservice / Serviceplatformen
DebitorForespørgselAfsend

Formål

Servicen understøtter, at fagsystemet kan søge og hente egne samt andres debitorregistreringer i kommunens debitorsystem. Servicen understøtter her og nu dataudveksling – straksleverance - af debitorregistreringer under en debitorkonto.

Nyt i denne version

Operationen ”HentDebitorkonto” er udvidet på følgende områder:
- Alle dataelementer og strukturer, som fagsystemer kan registrere på en Debitorkonto, kan returneres – også de nye, der oprettet med version 3.0 af servicen DebitorregistreringAfsend.
- Man kan nu se, om en debitorkonto er omfattet af en aftale om automatisk betaling af fordringer.
- Mere detaljeret information om debitorsystemets håndtering og gældende status for den enkelte fordring kan nu returneres: RettidigIndbetalingsDato, Betalingsmåde (FI-kort, Automatisk træk), hvorvidt der er bevilget henstand på fordringer (og evt. rykkere og renter), om fordringen (og evt. rykkere og renter) indgår i en betalingsaftale, hvilke fordringer en rykker gælder.
- Fordringens titel fra kommunens selvbetjeningsløsning kan returneres.
- Et evt. ”dybt” link til betaling af fordringen i debitorsystemets betalingsløsning kan returneres.
- I operationens søgekriterie er tilføjet mulighed for at forespørge på debitorkontoen i kontekst af en juridisk medhæfter. På dem måde vil man kunne se fordringer, påløbne omkostninger og frister, der gælder for den juridiske medhæfter.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorForespoergselAfsend/1

UUID: b20fcbeb-1bc0-47c8-bd06-90e88df9b2ed

EntityId: http://oir.serviceplatformen.dk/service/debitorforespoergselafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorForespoergselAfsend/1

UUID: b20fcbeb-1bc0-47c8-bd06-90e88df9b2ed

EntityId: http://oir.serviceplatformen.dk/service/debitorforespoergselafsend/1

Formål

Servicen understøtter, at fagsystemet kan søge og hente egne samt andres debitorregistreringer i kommunens debitorsystem. Servicen understøtter her og nu dataudveksling – straksleverance - af debitorregistreringer under en debitorkonto.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorForespoergselAfsend/1

UUID: b20fcbeb-1bc0-47c8-bd06-90e88df9b2ed

EntityId: http://oir.serviceplatformen.dk/service/debitorforespoergselafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorForespoergselAfsend/1

UUID: b20fcbeb-1bc0-47c8-bd06-90e88df9b2ed

EntityId: http://oir.serviceplatformen.dk/service/debitorforespoergselafsend/1

Webservice / Serviceplatformen
DebitorIndbetalingAfsend

Formål

Formålet med servicen er at give et fagsystem mulighed for at foretage indbetaling på fordringer i kommunens debitorsystem. Desuden giver den mulighed for at fremsøge fordringer, der kan indbetales på.

Servicen vil ofte anvendes af fagsystemet i kombination med beskedservicen FordringTilIndbetalingHent eller -Modtag.

Beskrivelse

Servicen omfatter beskedtypen: FordringTilIndbetaling

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorIndbetalingAfsend/1

UUID: d0ed926d-be52-4b12-bf4a-0513b594eed5

EntityId: http://oir.serviceplatformen.dk/service/debitorindbetalingafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorIndbetalingAfsend/1

UUID: d0ed926d-be52-4b12-bf4a-0513b594eed5

EntityId: http://oir.serviceplatformen.dk/service/debitorindbetalingafsend/1

Webservice / Serviceplatformen
DebitorkontoAnmodningAfsend

Formål

Denne service muliggør, at et fagsystem kan oversende en anmodning til et debitorsystem om at foretage en handling.

Udgangspunktet for alle servicens operationer er en debitorkonto.

Beskrivelse

Servicen understøtter, at et fagsysteme kan oprette en anmodning om en handling, som involverer en eller flere af fagsystemets debitorkonti i myndighedens debitorsystem. Servicens anvendes, når fagsystemet har behov for, at opkrævningsfunktionen - her repræsenteret ved debitorsystemet - udfører handlinger på fagsystemets debitorkonti, som kun debitorsystemet har adgang til at udføre.

I svaret på anmodningen får fagsystemet besked om, at handlingsønsket kan accepteres og evt. resultatet af handlingen, hvis der er tale om en her og nu handling. Handlingen kan dermed også gennemføres tidsforskudt for accepten af anmodning. Resultatet af handlingen vil i det tilfælde sendes af debitorsystemet til fagsystemet i en selvstændig svarservice.

Servicen understøtter fire varianter af debitorkontoanmodninger:

1. Anmodning om handling på én debitorkonto. Det kan dreje sig om massehandlinger på alle objekter af en given type under debitorkonto.
2. Anmodning om handling på en eller flere udspecificerede fordringer under en debitorkonto. Handlingerne vil dreje sig om tilstandsændringer på de specificerede fordringer eller massehandlinger på objekter under disse fordringer.
3. Anmodning om handlinger mellem to debitorkonti. Handlinger vil ofte skulle bruges til at flytte værdier fra objekter på den ene debitorkonto til tilsvarende objekter på den anden debitorkonto.
4. Anmodning om handlinger mellem udpegede fordringer på to debitorkonti. Handlinger vil ofte skulle bruges til at flytte værdier fra objekter på sættet af fordring på den ene debitorkonto til tilsvarende objekter på det sæt af fordringer, der er angivet som handlingens mål.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningAfsend/1

UUID: 6f93bebe-9898-11ed-b537-1706599258b5

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningAfsend/1

UUID: 6f93bebe-9898-11ed-b537-1706599258b5

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningafsend/1

Webservice / Serviceplatformen
DebitorkontoAnmodningSvarAfsend

Formål

Service til oversendelse af asynkront svar på en DebitorkontoAnmodning.

Beskrivelse

Servicen understøtter, at debitorsystemet kan afsende et forretningssvar til et fagsystem på resultatet af den handling, som er affødt af en debitorkontoanmodning, som fagsystemet tidligere har oprettet i myndighedens debitorsystem.

Afgivelse af forretningssvar forudsætter, at debitorsystemet tidligere har kvitteret med accept på debitorkontoanmodning til senere behandling.

Fagsystemet kan bruge svaret til håndtering af egne processer, der afventer den endelige tilbage-melding på en debitorkontoanmodning.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningSvarAfsend/1

UUID: 9ab5d456-9898-11ed-9b1c-eb4fae236c62

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningsvarafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningSvarAfsend/1

UUID: 9ab5d456-9898-11ed-9b1c-eb4fae236c62

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningsvarafsend/1