BRP API / Bewoning
BRP API Bewoning
The BRP API Bewoning is an API for consulting the historical occupancy of an address. With this API you can consult the composition of occupants of a dwelling on a reference date or within a period.
Functions
- Consult occupancy within a period (raadpleeg bewoning met periode): retrieve all occupants and possible occupants during the period supplied, by providing an addressable object identification and a period.
- Consult occupancy on a reference date (raadpleeg bewoning met peildatum): retrieve the composition of occupants on a specific date, by providing an addressable object identification and a reference date.
Getting started
- View the specification with Redoc
- Read the documentation
- Download the OAS3 specification
Use together with other BRP APIs
The BRP API Bewoning can be used in combination with the other BRP APIs:
- BRP Personen — searching and consulting persons
- BRP Verblijfplaatshistorie — consulting residence history
- BRP Reisdocumenten — consulting travel documents
Contact
- Product Owner: Cathy Dingemanse, [email protected]
- Customer zero: Melvin Lee, [email protected]
- Tester: Frank Samwel, [email protected]
- Reporting a bug: Create a bug issue >>
- Submitting improvements: Create an enhancement issue >>
Licence
Copyright © RvIG 2024. Licensed under the EUPL.