HAALCENTRAAL BRP API
BRP API / Verblijfplaatshistorie / BRP API Verblijfplaatshistorie

BRP API Verblijfplaatshistorie

What is verblijfplaatshistorie?

With the BRP API Verblijfplaatshistorie you can request the verblijfplaatshistorie of a person within a period or on a reference date. You then receive the residence where the person lived on the reference date supplied, or all the residences where the person stayed during the period supplied. You need that, for example, when you have to work out which municipality must bear the costs of a person's stay in an institution. For that you need to know in which municipality the person lived in the period before the stay in the institution.

What do you need?

In the BRP, persons are uniquely identified by their burgerservicenummer. You use this 9-digit number to indicate whose residence data you want to request.

Consulting the residence on a date

Consult the residence where a person stayed on a specific date by using the operation "RaadpleegMetPeildatum" and the parameter "peildatum".

If, for example, you want to know where the person stayed on 3 July 2021, you send the following request body:

{
  "burgerservicenummer": "999994669",
  "type": "RaadpleegMetPeildatum",
  "peildatum": "2021-07-03"
}

Consulting the residences during a period

Consult the residence or residences where a person stayed during a period by using the operation "RaadpleegMetPeriode" and the parameters "datumVan" and "datumTot".

If, for example, you want to know where the person stayed between 3 July 2021 and 8 October 2022, you send the following request body:

{
  "burgerservicenummer": "999994669",
  "type": "RaadpleegMetPeriode",
  "datumVan": "2021-07-03",
  "datumTot": "2022-10-08"
}

The result contains all residences where the person was registered for at least 1 day during the period. Residences are supplied in sorted order, so that the most current residence is the first in the list.

Derivation rules

The rules for including residences on the basis of the "datumVan" and "datumTot" supplied will follow shortly.

Read here how the BRP API Verblijfplaatshistorie handles different types of residence. For every residence, "datumVan" (the start date of the stay) is included in the answer. Where the person no longer stays there, "datumTot" is included as the date on which the person no longer stays there. Read the rules for supplying datumVan and datumTot here.

Established as not residing at the address

If you request residence data and/or address lines of a person who no longer resides at the registered address, the indicatieVastgesteldVerblijftNietOpAdres field is supplied with the value true. This means that an investigation into the residence of the person has shown that the person does not live at this address. Read here how the indicatieVastgesteldVerblijftNietOpAdres field is determined.