BRP Historie

Getting Started

De ‘BRP-historie bevragen’ Web API is gespecificeerd in OpenAPI specifications (OAS).

Wil je de API gebruiken? Dit kun je doen:

  1. Bekijk de functionaliteit en specificaties
  2. Implementeer de API Client
  3. Probeer en test de API

Functionaliteit en specificaties

Je kunt historie op drie manieren opzoeken:

  1. Met een peildatum. Je krijgt dan de situatie op de opgegeven datum.
  2. Met een periode (datumVan en datumTotEnMet). Je krijgt dan de historie binnen de opgegeven periode.
  3. Zonder peildatum of periode. Je krijgt dan alle historie die de registratie heeft.

Je kunt een visuele weergave van de specificatie bekijken met Swagger UI of Redoc.

Je kunt de functionele documentatie vinden in de features.

Implementeer de API client

Client code kun je genereren met de “genereervariant” van de API-specificaties en een code generator. Een overzicht met codegeneratoren kun je vinden op OpenAPI.Tools.

Deze repo bevat scripts waarmee je met OpenAPI Generator client code kunt genereren in JAVA, .NET (Full Framework & Core) en Python. De makkelijkste manier om de code generatie scripts te gebruiken, is door deze repo te clonen. Na het clonen kun je met npm install de benodigde packages installeren en kun je met npm run

  • oas:generate-java-client (voor JAVA client code)
  • oas:generate-netcore-client (voor .NET Core client code)
  • oas:generate-net-client (voor .NET Full Framework client code)
  • oas:generate-python-client (voor Python client code)

Een lijst met andere ondersteunde generator opties kun je vinden in de Generators List van OpenAPI Generator.

Note. De prerequisite van OpenAPI Generator is JAVA. Je moet een JAVA runtime installeren voordat je OpenAPI Generator kunt gebruiken

Probeer en test de API

Wil je de ‘BRP-historie bevragen’ Web API proberen en testen? Kijk op: https://www.haalcentraal.nl/haalcentraal/api/brphistorie

Om de web api te gebruiken heb je een apikey nodig. Deze voeg je aan een request toe als header “X-API-KEY”. Een API-key vraag je aan bij de product owner cathy.dingemanse@denhaag.nl.

De Haal Centraal probeeromgeving gebruikt GBA-V op basis van de gemeentelijke autorisatie “Algemene gemeentetaken” voor buitengemeentelijke personen. Dit betekent dat de GBA-V niet alle gegevens teruggeeft die in de response zijn gedefinieerd. Het endpoint nationaliteithistorie werkt niet in de probeeromgeving, omdat de GBA-V autorisatie voor afnemers daarvoor niet voldoende gegevens bevat. In de API mapping kun je zien welke gegevens wel of niet onder deze autorisatie vallen.

Je kan de Haal Centraal probeeromgeving niet gebruiken vanuit de browser, dus ook niet vanuit de browserversie van Postman. Gebruik dus de desktopversie van een testtool (zoals Postman) om berichten te sturen.

Importeer de specificaties in Postman

De werking van de API is het makkelijkst te testen met behulp van Postman. We hebben al een Postman collection voor je klaargezet. Deze kun je importeren in Postman.

Configureer de url en api key

  1. Klik bij “BRP historie bevragen” op de drie bolletjes.
  2. Klik vervolgens op Edit
  3. Selecteer tabblad “Authorization”
  4. Kies TYPE “API Key”
  5. Vul in Key: “x-api-key”, Value: de API key die je van Cathy hebt ontvangen, Add to: “Header”
  6. Selecteer tabblad “Variables”
  7. Vul bij baseUrl INITIAL VALUE en bij CURRENT VALUE: https://www.haalcentraal.nl/haalcentraal/api/brphistorie
  8. Klik op de knop Update

Testpersonen

Deze tabel bevat de burgerservicenummers van testpersonen voor specifieke situaties waarmee de ‘BRP historie bevragen’ Web API kan worden getest.

burgerservicenummer situatie
999993847 verblijfplaats in onderzoek
999993483 uitgebreide verblijfplaatshistorie
999990482 niet-BAG adres
000009921 locatiebeschrijving
999993653 niet-Nederlandse nationaliteit
999995017 actuele en historische verblijfstitel
999994669 verblijfplaatshistorie met verblijf buitenland en locatiebeschrijving en adrescorrectie
999992806 uitgebreide verblijfstitelhistorie
999993926 actuele en meerdere ex-partners
999991905 twee beëindigde relaties
999993550 partner niet ingeschreven

De API gebruikt de GBA-V proefomgeving. Alle testpersonen die daarin voorkomen kun je ook in de API gebruiken. De volledige set testpersonen kan worden gedownload bij de RvIG. Een vertaling van GBA-V (LO GBA) attributen naar BRP API properties staat beschreven in de BRP-LO GBA mapping.