Situering

Dit document beschrijft het gebruik en de werking van de webservice ZoekPersoonOpNaam 2.0 zoals deze door Digitaal Vlaanderen op het MAGDA platform aangeboden wordt.

De webservice is in staat personen op te vragen bij het Rijksregister als bij/via KSZ.

Gegevensbronnen

De authentieke bron van de gegevens is het Rijksregister of de KSZ.

Voor meer informatie met betrekking tot de inhoud van de persoonsgegevens wordt verwezen naar de Rijksregister onderrichtingen terug te vinden via volgende URL: http://www.ibz.rrn.fgov.be/index.php?id=2485&L=1

Voor wat KSZ betreft kunnen de gegevens opgevraagd worden via twee gelijkaardige diensten:

• De vertrouwde SSDN-dienst (zolang deze nog ter beschikking blijft).
  Hiervoor wordt verwezen naar de documenten beschikbaar op hun website

• Hun nieuwe SOA-dienst. Meer informatie hierover is terug te vinden in bijlage:

Open

Functioneel is er tussen beide diensten slechts één klein verschil. Bij de SOA-dienst van KSZ kan er binnen burgerlijke staat, in plaats van een INSZ, een partner referentie terugkomen ter identificatie van de partner.

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te mogen gebruiken:

• Toelating tot het MAGDA platform

• Machtiging van het sectoraal comité van het Rijksregister en/of

• Machtiging van het sectoraal comité van de Sociale Zekerheid

Batch

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen of neem contact op met de MAGDA Service Desk.

Functionaliteiten

De webservice ZoekPersoonOpNaam 2.0 laat de afnemer van het MAGDA platform toe personen op te zoeken in het Rijksregister of de KSZ, dit op basis van verschillende parameters:

• Achternaam (zie paragraaf “belangrijke opmerkingen” voor de schrijfwijze van de achternaam en de voornamen).

• Tot twee voornamen

• Geboortedatum (eventueel met een tolerantie)

• Geslacht

• Niscode van gemeente van woonplaats

Het is mogelijk om enkel op achternaam te zoeken.

Eens de afnemer de request gelanceerd heeft wordt de vraag doorgestuurd naar het Rijksregister of de KSZ. MAGDA ontvangt het antwoord en transformeert dit naar één of meerdere Persoon-elementen. Afhankelijk van de verkregen machtigingen worden bepaalde gegevens al dan niet gefilterd.

Onderstaande tabel geeft een overzicht van de in de ZoekPersoonOpNaam 2.0 beschikbare persoonsgegevens en hun relatie met de informatietypes van het Rijksregister. Persoonsgegevens komende via KSZ zijn bij deze dienst rijker. In onderstaande tabel  is opgenomen welke gegevens (potentieel) beschikbaar zijn.

De overige gegevens die in een Persoon bevat zitten komen niet terug in deze webservice, al zijn ze wel opgenomen in de XSD.

Werking

Opties

Volgende configuratieparameters kunnen op het MAGDA platform ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

• Op te roepen bron: tot drie bronnen kunnen geconfigureerd worden

Opvraging

Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats.

Hierna vindt er een functionele validatie plaats van de vraag. Nadien zal de webservice achterliggend transactie 40 bij het Rijksregister, de IdentifyPerson service of de PersonService (searchPersonPhonetically) van KSZ oproepen. Ontvangt de webservice een antwoord – hetzij de persoonsgegevens, hetzij een foutcode – wordt dit gevalideerd en omgezet in een MAGDA XML formaat. Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. De beschikbaarheid van de gegevens is echter volledig afhankelijk van Rijksregister of KSZ die in principe 24/7 beschikbaar zijn..

Bij geplande onbeschikbaarheden van het Rijksregister of de KSZ worden de afnemers op de hoogte gebracht via mail. Bij een onverwachte onbeschikbaarheid wordt in het mate van het mogelijk een mail uitgestuurd (dit is als Digitaal Vlaanderen zelf op de hoogte gebracht wordt door Rijksregister of KSZ).

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.

Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie