HAAL✻CENTRAAL BRP API
BRP API / Testing in the Pilot Environment

Testing in the Pilot Environment

Have you built your client application using the BRP API mock, and are you ready for the acceptance test in RvIG's environment?

Then you can test the network connection, the access security and the communication with the API in the pilot environment. Every consumer of RvIG or municipality may set up at most one connection to the BRP API pilot environment. No covenant is required yet for connecting to the pilot environment.

Conditions

Before you can use the API you must request a token. To request one you need:

Step 1: Send a request for client credentials for the pilot environment to [email protected]

Step 2: Configure your gateway

Important information for configuring your gateway:

Step 3: Retrieve the OAuth token

Send this request to request a token in the pilot environment, replacing everything between double braces with the credentials you have:

curl --location -–request POST 'https://auth.npr.idm.diginetwerk.net/nidp/oauth/nam/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={{client-id}}' \
--data-urlencode 'client_secret={{client-secret}}' \
--data-urlencode 'scope={{ afnemersindicatie }}-{{OIN}}' \
--data-urlencode 'resourceServer=ResourceServer01'

You then receive an application/json message in reply that looks like this:

{
  "access_token": "{{access token}}",
  "token_type": "bearer",
  "expires_in": {{geldigheidsduur}},
  "scope": "{{scope}}"
}

You send the token in “access_token” with every request to the API, by entering it in the request header “Authorization”, preceded by “Bearer ”. Note that there is 1 space between “Bearer” and the token, and no space or other character after the token.

The token has limited validity and can be used for several API requests during the validity period. “expires_in” states how long (in seconds) the token is valid.

Step 4: Send a request

Send this request with a correct example request body to the API in the pilot environment:

curl --location -–request POST 'https://apigw.npr.idm.diginetwerk.net/lap/api/brp/personen' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}} \
--data '{
  "fields": ["naam.volledigeNaam", "leeftijd", "geslacht", "adressering"],
  "type": "RaadpleegMetBurgerservicenummer",
  "burgerservicenummer": ["999993483"]
}'

Step 5: Test your client application

Test your application with this test set. Successful? Then you can request a connection to the production environment.

Connecting to the production environment

Conditions

Step 1: Request the connection to the production environment via [email protected]. You then receive a draft covenant.

Step 2: Configure your gateway

Important information for configuring your gateway: