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 refenreties opgegevens te worden. De lijst van referenties kan opgevraagd worden met de GET persons/officialDocumentReferences diesnt.
Gegevensbronnen
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 dienst te mogen gebruiken:
- Toelating tot het MAGDA platform
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 referenties van de akten die beschikbaar zijn voor opvraging met de GET OfficialDocument dienst. Naast de referenties bevat het antwoord ook de gegevens van de personen die betrokken zijn bij de akte.
Werking
Aandachtspunten
- In het OAuth authenticatie token kan het ACM/IDM token meegegeven worden om zo het INSZ van de aanvrager te garanderen
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
- Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing
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.
Wijzigingshistoriek
| Datum | Aanpassingen |
|---|
| Eerste versie van de handleiding |
