Getting Started
Municipalities and other organizations holding an authorization decision can register to take part in the Data Minimization Experiment. Send an email to [email protected] to arrange an introductory meeting and onboarding.
As a developer you can get started straight away:
- View the OAS3 specification in Redoc for the BRP API Personen, Bewoning and Verblijfplaatshistorie.
- Download the OAS specification for BRP API Personen, Bewoning or Verblijfplaatshistorie to generate consumer code.
- Build the connection to the BRP API in your application and test it locally.
- Request an access token for the pilot environment and carry out an acceptance test. You are ready for production.
Step 1: Functionality and specifications
View the OAS3 specification in Redoc for the BRP API Personen, Bewoning and Verblijfplaatshistorie. Work out what you need, and what authorization has been granted for.
Step 2: Download the OAS
Download the OAS3 for BRP API Personen, Bewoning or Verblijfplaatshistorie that you need and use it to generate consumer code.
Step 3: Try and test the BRP API locally or in the pilot environment
Read how to filter the response of the BRP API Personen, so that your application requests only the information that is needed at that moment and for which authorization has been granted. If you wish, use the tool for composing fields.
Test your application by using a mock of the BRP API Personen and running it locally as a containerized application. You can easily host this containerized application on a local machine or in your test environment.
Try the API out and test your application in the pilot environment.
Step 4: Request an access token for the RvIG pilot environment
Read how to connect to the RvIG pilot and production environments.