Static BRP test data

Inleiding

HaalCentraal is een initiatief waarmee basisgegevens rechtstreeks bij de landelijke registraties kunnen worden opgevraagd. HaalCentraal biedt verschillende APIs aan, onder andere de BRP API Personen (BRP = Basisregistratie Personen).

HaalCentraal biedt een testversie van deze API aan die lokaal gestart kan worden. Ook is de testversie online beschikbaar, dit vereist echter de aanvraag van een API key. Voor extra gebruiksgemak biedt Digilab deze testversie van de API openbaar aan. Deze is bereikbaar via het endpoint https://brp-api-mock.apps.digilab.network/haalcentraal/api/brp/personen.

Voorbeeld

De API kan als volgt bereikt worden:

curl -X POST 'https://brp-api-mock.apps.digilab.network/haalcentraal/api/brp/personen' -H 'Content-Type: application/json' -d '{
    "type": "RaadpleegMetBurgerservicenummer",
    "burgerservicenummer": ["999993653"],
    "fields": ["burgerservicenummer", "naam"]
}'

Dit geeft (na formattering) de volgende response:

{
    "type": "RaadpleegMetBurgerservicenummer",
    "personen": [
        {
            "burgerservicenummer": "999993653",
            "naam": {
                "aanduidingNaamgebruik": {
                    "code": "E"
                },
                "voornamen": "Suzanne",
                "geslachtsnaam": "Moulin",
                "voorletters": "S.",
                "volledigeNaam": "Suzanne Moulin"
            }
        }
    ]
}

Meer informatie

Voor uitgebreider gebruik, zie de API specificatie.

Zie ook het overzicht van beschikbare testpersonen / -BSN’s.

Voor een vergelijkbare API met meer personen, random gegenereerd, zie de Digilab Synthetic Data Generator (documentatie in het Engels).