Getting Started

The ‘BRP tabellen bevragen’ Web API is specified in OpenAPI specifications (OAS).

Do you want to use the API? This is what you can do:

1. View the functionality and specifications
2. Implement the API client
3. Try and test the API

Functionality and specifications

With this API you can:

• request an overview of the national tables available in the API
• search a national table by (part of) the description
• consult a description belonging to a code in a national table
• search a code by (part of) the description in a national table

Searching in the BRP tabellen API is case-insensitive and supports the use of the wildcard character *.

By default the API supplies no ended table values when searching, such as countries that no longer exist. You can also find ended values by including the parameter inclusiefbeeindigd=true in the request.

You can view a visual representation of the specification with Swagger UI or Redoc.

You can find the functional documentation in the features.

Implement the API client

You can generate client code with the “genereervariant” of the API specifications and a code generator. An overview of code generators can be found at OpenAPI.Tools.

This repo contains scripts with which you can generate client code in JAVA, .NET (Full Framework and Core) and Python using OpenAPI Generator. The easiest way to use the code generation scripts is to clone this repo. After cloning you can install the packages needed with npm install, and with npm run <script name> you can run one of the following scripts:

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

A list of other supported generator options can be found in the Generators List of OpenAPI Generator.

Note. The prerequisite of OpenAPI Generator is JAVA. You must install a JAVA runtime before you can use OpenAPI Generator.

Trying and testing the API

Do you want to try and test the ‘BRP tabellen bevragen’ Web API? Go to: https://www.haalcentraal.nl/haalcentraal/api/landelijke_tabellen

To use the web API you need an API key. You add this to a request as the header “X-API-KEY”. You request an API key from the product owner [email protected].

The tables in the Haal Centraal pilot environment are not maintained. So these are not the current tables.

You cannot use the Haal Centraal pilot environment from the browser, and therefore not from the browser version of Postman either. So use the desktop version of a test tool (such as Postman) to send messages.

Import the specifications into Postman

The behaviour of the API is easiest to test using Postman. We have already prepared a Postman collection for you. You can import this into Postman.

Configure the URL and API key

1. Under “Landelijke tabellen”, click the three dots.
2. Then click Edit.
3. Select the “Authorization” tab.
4. Choose TYPE “API Key”.
5. Enter Key: “x-api-key”, Value: the API key you received from Cathy, Add to: “Header”.
6. Select the “Variables” tab.
7. At baseUrl, enter for INITIAL VALUE and CURRENT VALUE: https://www.haalcentraal.nl/haalcentraal/api/brphistorie
8. Click the Update button.