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

RegistreerInschrijving 02.01

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

/wiki/spaces/MDI/pages/1733952108

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

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 wordt de dienst verder behandeld en worden request parameters 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

• 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.