Situering

De officialDocumentsReferences dienst laat toe om referenties van de beschikbare akten burgerlijke stand uit de DABS database bij het RijksRegister op te vragen. Deze referenties kunnen gebruikt worden om met de officialDocument dienst een uittreksel of afschrift op te vragen.

Verwante diensten

RegistreerInschrijving 02.00

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

GET person/officialDocuments - v1

Eens de lijst van de referenties van de beschikbare aktes is opgevraagd met de OfficialDocumentsList dienst kunnen deze referenties gebruikt worden met de OfficialDocument dienst om een extract of uittreksel op te vragen in PDF formaat.

GET person/officialDocumentMigrations - v1

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. Het is in deze situatie noodzakelijk om ook dit INSZ mee te geven in de query parameters.

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 die welke 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.

Werking

Aandachtspunten

• In het OAuth authenticatie token kan het ACM/IDM token meegegeven worden om zo het INSZ van de aanvrager te garanderen. indien deze extentie niet gedaan wordt is het noodzakelijk het RR nummer in te schrijven in het Persoonsregister met de RegistreerInschrijving 02.00 dienst

Opvraging

Het antwoord van deze dienst wordt gemaakt op basis van het antwoord dat we ontvangen van de achterliggende dienst (DABS database bij FOD Justitie).

Responsetijden & Beschikbaarheid

Logging

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

Ondersteunde talen

De akten kunnen opgevraagd worden in Nederlands, Frans of Duits door de juiste parameter mee te geven in de vraag. Wordt de taal niet meegegeven wordt aangenomen dat de akten in de Nederlandse taal worden opgevraagd.

Op deze pagina

Omgevingsinformatie