Haal Centraal BRP bevragen¶
Haal Centraal is an initiative to transform the currently used SOAP-services to consult the base registration, to modern RESTful API’s.
The Haal Centraal BRP bevragen API allows you to retrieve personal information about the person filling out the form, based on the BSN.
Note
This service contains sensitive data and requires a connection to a specific client system. Currently however, there are very few suppliers who offer this service.
On the Haal Centraal BRP bevragen API Github, you can request credentials for a test environment that uses an API key.
Configuration¶
Obtain credentials to access the Haal Centraal BRP bevragen API
In Open Forms, navigate to: Configuration > Services
Click Add service and fill in the following details:
Label: Fill in a human readable label, for example:
My BRP API
Type: ORC (Overige)
API root URL: URL provided by supplier
Authorization type: API key (but can differ per supplier)
Header key: Authorization
Header value: The API key from step 1
Click Save
Navigate to Configuration > Configuration overview. In the Prefill plugins group, click on Configuration for the Haal Centraal: BRP Personen Bevragen line.
Select for the BRP Personen Bevragen API, the [ORC (Overige)] My BRP API option, that we just created in step 3.
Select the correct version for BRP Personen Bevragen API version - new installations likely use
v2.0
.Click Save
The Haal Centraal configuration is now complete.
Configuration of protocollering headers¶
When using the BRP API via a gateway, you likely need to configure extra headers.
Doelbinding and Verwerking¶
These two values correspond to the following headers: x-doelbinding
and x-verwerking
. Possible values
depends on your gateway supplier and/or organization.
They can be configured per form or as a global default.
Configuration per form¶
Create a form with a component using a prefill plugin. An example can be found here. Be sure to select Haal Centraal: BRP Personen Bevragen.
In the Advanced configuration tab under the Processing group, fill in the values for the two headers:
BRP Personen purpose limitation header value: The Doelbinding value.
BRP Personen processing header value: The Verwerking value.
Global default¶
You can also define global defaults that will be used if no values are configured at the form level.
Navigate to Configuration > Configuration overview. In the Prefill plugins group, click on Configuration for the Haal Centraal: BRP Personen Bevragen line.
Fill in the values for the two headers:
Default BRP Personen purpose limitation header value: The Doelbinding value.
Default BRP Personen processing header value: The Verwerking value.
Origin OIN¶
This value corresponds to the x-origin-oin
header.
Navigate to Configuration > General configuration.
In the Organization configuration, fill in the value for the Organization OIN.
Note
An extra header x-gebruiker
will automatically be set. If the form is being filled in by
an authenticated employee, the employee ID will be used. Otherwise, a default value of BurgerZelf
will be used.
Technical¶
API |
Supported versions |
---|---|
BRP bevragen API |
2.0 |
BRP bevragen API |
1.3 |