Getting Started

The ‘BRK Bevragen’ API is specified using the OpenAPI Specifications (OAS3).

To connect, you can go through the following steps:

1. Register with Kadaster to obtain access
2. View the functionality and specifications
3. Implement the API client
4. Try and test the API
5. Connect to production

Registering

Register with Kadaster to connect and obtain access to the test environment. You will then receive, among other things, an API key that is needed for access to the test environment.

Functionality and specifications

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

You can find the functional documentation in the features.

Available resources

The following Basisregistratie Kadaster data can be requested:

• KadastraalOnroerendeZaak
• ZakelijkGerechtigde
• KadasterNatuurlijkPersoon
• KadasterNietNatuurlijkPersoon
• Hypotheek
• Beslag
• PrivaatrechtelijkeBeperking
• PubliekrechtelijkeBeperking
• Stuk
• Stukdeel

KadastraalOnroerendeZaak

• Requesting one specific kadastraalonroerendezaak resource by a kadastraalonroerendezaakidentificatie.
• Requesting one specific kadastraalonroerendezaak resource by a kadastraleaanduiding.
• Requesting one specific kadastraalonroerendezaak resource by a nummeraanduidingIdentificatie.
• Requesting a collection of kadastraalonroerendezaak resources by an address (postal code, house number, house letter, house number addition).
• Requesting a collection of kadastraalonroerendezaak resources where a cadastral natural person is the entitled party, by a kadasterpersoonidentificatie.
• Requesting a collection of kadastraalonroerendezaak resources where a cadastral non-natural person is the entitled party, by a kadasterpersoonidentificatie.
• Requesting a collection of kadastraalonroerendezaak resources where a registered natural person is the entitled party, by a citizen service number.

ZakelijkGerechtigde

• Requesting a collection of zakelijkgerechtigde resources of one specific kadastraalonroerendezaak by a kadastraalonroerendezaakidentificatie.
• Requesting one specific zakelijkgerechtigde resource by a zakelijkgerechtigdeidentificatie.

KadasterNatuurlijkPersoon

• Requesting one specific kadaster natuurlijk persoon resource by a kadasterpersoonidentificatie.
• Requesting a collection of kadaster natuurlijkpersoon resources by a search term. (See the feature zoeken kadasternatuurlijkpersoon.)

KadasterNietNatuurlijkPersoon

• Requesting one specific kadaster nietnatuurlijk persoon resource by a kadasterpersoonidentificatie.
• Requesting a collection of kadaster nietnatuurlijk persoon resources by a search term. (See the feature zoeken kadasternietnatuurlijkpersoon.)

Hypotheek

• Requesting one specific hypotheek resource by a hypotheekidentificatie and kadastraalonroerendezaakidentificatie.
• Requesting a collection of hypotheek resources belonging to a cadastral immovable property, by a kadastraalonroerendezaakidentificatie.

Beslag

• Requesting one specific beslag resource by a beslagidentificatie and kadastraalonroerendezaakidentificatie.
• Requesting a collection of beslag resources belonging to a cadastral immovable property, by a kadastraalonroerendezaakidentificatie.

PrivaatrechtelijkeBeperking

• Requesting one specific privaatrechtelijkebeperking resource by a privaatrechtelijkebeperkingidentificatie and kadastraalonroerendezaakidentificatie.
• Requesting a collection of privaatrechtelijkebeperking resources belonging to a cadastral immovable property, by a kadastraalonroerendezaakidentificatie.

PubliekrechtelijkeBeperking

• Requesting a collection of publiekrechtelijkebeperking resources by a kadastraalonroerendezaakidentificatie.

Stuk

• Requesting one specific stuk resource by a stukidentificatie.

Stukdeel

• Requesting one specific stukdeel resource by a stukdeelidentificatie.

General

There are also a few general functions that apply to all the requests above:

• Use of the fields parameter to filter the response. (For its behaviour, see the feature fields.)
• Use of the expand parameter to expose subresources. (For its behaviour, see the feature expand.)
• Fields that are always supplied. (For its behaviour, see the feature levering velden.)

Combination of fields that are always supplied as mandatory:

• HAL links, which are sometimes supplied templated.

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

The behaviour of the API is easiest to test using Postman. You can import the openapi.yaml as a project, after which the various requests that this API supports are loaded. You can also use the project we have made for you: BRK-Bevragen-postman-collection.json. In it you only have to fill in the base URL and the authentication (API key).

Configure the URL and API key

1. Under “Kadaster - BRK-Bevragen API”, 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 Kadaster, Add to: “Header”.
6. Select the “Variables” tab.
7. At baseUrl, enter the URL for INITIAL VALUE and CURRENT VALUE.
8. Click the Update button.

The test environment of the API can be reached at the following URLs:

• Secure connection with an API key only: https://api.brk.kadaster.nl/esd-eto-apikey/bevragen/v2/
• Secure connection with an API key and mTLS: https://api.brk.kadaster.nl/esd-eto/bevragen/v2/

For this, request an API key and PKIoverheid certificate.

Test Cases

The tables below contain test cases for specific situations with which the behaviour of the API can be tested in the test environment. More details on what test data the test cases contain can be found in test cases.

Immovable Properties (Onroerende Zaken)

Kadaster Natuurlijke Personen

Ingeschreven Natuurlijke Personen

Niet Natuurlijke Personen

Connecting to production

After successful testing you can connect to the production environment. Kadaster will tell you which steps are needed for this.

Request an API key and PKIoverheid certificate for connecting to the production environment.

URL

The production environment of the API can be reached at the following URL: https://api.brk.kadaster.nl/esd/bevragen/v2/