BRP Reisdocumenten Web API Features

De BRP Reisdocumenten Web API maakt het mogelijk om gegevens van reisdocumenten in de basisregistratie personen (BRP) te raadplegen. De reisdocumenten worden opgezocht met behulp van hun reisdocumentnummer of met behulp van de burgerservicenummer van zijn houder.

Algemene Verordening Gegevensbescherming (AVG)

De ‘BRP Reisdocumenten’ Web API is ontworpen conform de REST principes. Om ook aan de AVG te conformeren zijn er concessies gedaan met betrekking tot het toepassen van de REST principes. De belangrijkste concessie is dat de POST methode en niet de GET methode wordt gebruikt om reisdocumenten te bevragen. Dit zorgt er voor dat er geen persoonlijk identificeerbare informatie (PII) terecht komen in de url van een request en daardoor ook niet in server logs.

Zoeken van reisdocumenten

Reisdocumenten kunnen worden opgezocht met behulp van de burgerservicenummer van hun houder. Hiervoor wordt de volgende operatie gebruikt:

• zoek met burgerservicenummer
  • overzicht
  • fout cases

Het resultaat van deze operatie is een Reisdocument collectie/lijst.

Raadplegen van reisdocumenten

Als het reisdocumentnummer van de te bevragen reisdocument bekend is, moet hiervoor de volgende operatie worden gebruikt:

• raadpleeg met reisdocumentnummer
  • overzicht
  • fout cases

Het resultaat van deze operatie is een Reisdocument collectie/lijst.

Filteren van de velden van de gevonden reisdocumenten

Gebruik bij elke bevraging (verplicht) de fields parameter om aan te geven welke velden van de gevonden reisdocument(en) geleverd moeten worden. Om de privacy van de houder van de gevraagde reisdocumenten te beschermen mogen alleen velden worden gevraagd waarvoor jouw organisatie doelbinding heeft. Met de fields parameter beperk je de op te vragen velden tot wat nodig is voor de uit te voeren taak. Bijkomend voordeel van deze data minimalisatie is dat je bijdraagt aan verduurzaming. Hoe minder velden je vraagt, hoe minder de server en het netwerk worden belast.

Je vraagt een veld op door het volledige pad van het betreffende veld op te geven in de fields parameter. Het volledige pad van een veld is de samenvoeging van de naam van het veld en de namen van zijn ‘ouder’ velden met een ‘.’ karakter tussen de veldnamen. Voorbeelden van volledige paden zijn:

• houder.burgerservicenummer (volledig pad van het burgerservicenummer veld van de houder van een reisdocument)

Zie de raadpleeg met reisdocumentnummer fields, de zoek met burgerservicenummer fields en de fields fout cases feature bestanden voor meer informatie en voorbeelden over het gebruik van veldpaden en de fields parameter.

Filteren van datum velden

De BRP Reisdocumenten Web API kent de volgende datum types:

• VolledigeDatum
• DatumOnbekend
• JaarDatum
• JaarMaandDatum

en het volgende waardetabel type:

• Waardetabel (soort reisdocument, aanduiding inhouding of vermissing)

Bij het vragen van één of meerdere velden van deze types worden altijd alle velden van het gevraagde type geleverd. In de raadpleeg met reisdocumentnummer fields en de zoek met burgerservicenummer fields feature bestanden zijn voorbeelden hiervan opgenomen.

Standaard geleverde velden

De volgende velden worden automatisch geleverd als zij van toepassing zijn:

• geheimhoudingPersoonsgegevens
• inOnderzoek
• opschortingBijhouding

Automatisch geleverde velden mogen niet worden gevraagd met de fields parameter. In het fields feature bestand zijn onder Rule: Automatisch geleverde velden mogen niet worden gevraagd voorbeelden hiervan opgenomen.

Geen/null/false waarde en leeg object waarde

Om de payload van een response klein te houden, is er voor gekozen om velden met de volgende waarden niet te leveren in de response:

• niet gevraagde velden. Deze velden hebben null als waarde.
• gevraagde velden die het gevraagde reisdocument niet heeft. Deze velden hebben null als waarde. Voorbeeld: inhoudingOfVermissing.datum veld wordt gevraagd voor een reisdocument dat niet is ingehouden of als vermist is opgegeven.
• gevraagde of automatisch geleverde velden hebben de false waarde. Voorbeeld: geheimhoudingPersoonsgegevens velden wordt niet geleverd als de houder niet om geheimhouding heeft verzocht.
• gevraagde velden betreft een groep velden die de persoon niet heeft. Voorbeeld: inhoudingOfVermissing velden wordt gevraagd voor een reisdocument dat niet is ingehouden of als vermist is opgegeven.
• gevraagde velden hebben geen aanduiding in onderzoek.