DIGITAAL VLAANDEREN
Beschrijving Vraag (GET persons/officialDocuments-v1)
Algemeen
De GET persons/officialDocuments-V1 vraag laat toe om een PDF extract of akte op te vragen uit de Database van Akten Burgerlijke Stand
Detail
Element | Opmerkingen | Verplicht |
|---|---|---|
x-correlation-id | Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Dit is het transactie ID, gebruikt voor logging en foutafhandeling. | Ja |
personNumber | INSZ van de persoon waarvoor akten worden opgezocht. Indien het ACM/IDM token gebruikt wordt bij het opvragen van het OAuth token dient de INSZ die gekoppel daan het ACM/IDM token overeen te komen met deze parameter | Ja |
language | De taal van de opgevraagde akte. Volgende taal keuzen zijn mogelijk:
Indien de taal niet opgegeven wordt, zal de akte in de Nederlandse taal worden opgevraagd | Nee |
documentReference | De referentie van de akte zoals opgegeven door de https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/1956151652 dienst | Ja |
actType | Template die moet gebruikt worden om een extract aan te maken. A (Art16) kan enkel gebruikt worden voor geboorte-, huwelijks- en overlijdensaktes
| Ja |
Validaties op vraag
Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
personNumber | De INSZ opgegeven in deze parameter moet voldoen aan de checksum97 validatie. | Status : 400 “Bad Request” Detail : INSZ in the query parameters has an invalid structure |
personNumber | Indien de INSZ ook meegegeven wordt in het OAuth token, door extentie van dat token met het ACM/IDM token, zal het opgegeven INSZ vergeleken worden met de waarde in de personNumber parameter. | Status : 400 “Bad Request” Detail : personNumber parameter does not match the ACM/IDM token |
Codetabellen Vraag
Er worden geen codetabellen gebruikt in de vraag
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen