Situering
De GET persons/officialDocuments dienst laat toe om uittreksels en documenten van akten burgerlijke stand uit de DABS database bij het RijksRegister op te vragen in PDF formaat. De referenties van deze documenten kunnen opgevraagd worden met de GET persons/officialDocumentReferences dienst.
Verwante diensten
Indien het niet mogelijk is om het INSZ mee te geven met het OAuth token in het noodzakelijk het INSZ in te schrijven in het Inschrijvingsregsiter voor personen. Dit dient te gebeuren vóór dit INSZ gebruikt wordt in de dienst
Om de documenten op te vragen dienen referenties opgegevens te worden. De lijst van referenties kan opgevraagd worden met de GET persons/officialDocumentReferences dienst.
Bij het opvragen van de referenties kan er een migratiecode doorgeven worden. Met die code kan dan in deze dienst de migratie aangevraagd worden van een registratie die nog niet in de DABS databank. Na twee werkdagen zal de akte dan in de databank opvraagbaar zijn.
Gegevensbronnen
Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.
Gebruiksvoorwaarden
Om gebruik te kunnen maken van deze dienst dient men een machtiging te hebben die toegang geeft tot deze gegevens en een aansluitingsprocedure te doorlopen.
Functionaliteiten
De dienst wordt aangeboden met het REST protocol en JSON als datastructuur.
Vraag
Bij het connecteren met deze dienst kan bij het opvragen van het OAuth token het ADM/ICM token meegegeven worden. Hierdoor wordt het officiële INSZ van de aanvrager meegeven in het OAuth token waardoor MAGDA zekerheid heeft over de aanvrager.
Nadat het OAuth token gevalideerd is, het meegestuurd INSZ uit het token gehaald is, wordt deze INSZ vergeleken met de INSZ die in de query parameters is opgegeven. Deze moet dezelfde zijn als in het token zit omdat deze garandeert dat er data opgevraagd wordt voor de persoon die de opvraging doet.
Na de validatie van de request parameters worden deze gemapt naar de bron SOAP request en doorgestuurd naar de bron.
Antwoord
Het antwoord van de bron wordt gevalideerd en de ontvangen gegevens worden overgezet van XML naar JSON. Dit JSON object wordt van via REST doorgestuurd naar de afnemer. Het antwoord bevat de referentie van de akten en de akte of uittreksel in een BASE64 gecodeerd PDF bestand.
Werking
Aandachtspunten
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
Opvraging
Het antwoord van deze dienst wordt gemaakt op basis van het antwoord dat we ontvangen van de achterliggende dienst (DABS database via RijksRegister).
Responsetijden & Beschikbaarheid
Logging
De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".
Ondersteunde talen
MAGDA ondersteunt de Nederlandse taal.
