BRK Bevragen

Getting Started

De ‘BRK Bevragen’ API is gespecificeerd met behulp van de OpenAPI Specifications (OAS3).

Om aan te sluiten kun je de volgende stappen doorlopen:

  1. Meld je aan bij het kadaster om toegang te krijgen
  2. Bekijk de functionaliteit en specificaties
  3. Implementeer de API
  4. Probeer en test de API
  5. Sluit aan op productie

Aanmelden om aan te sluiten

Meld je aan bij het kadaster om aan te sluiten en voor toegang tot de testomgeving. Je ontvangt dan o.a. een API-key die nodig is voor toegang tot de testomgeving.

Functionaliteit en specificaties

Je kunt een visuele representatie van de specificatie bekijken met Swagger UI of Redoc.

Je kunt de functionele documentatie vinden in de features.

Beschikbare resources

De volgende Basis Registratie Kadaster gegevens kunnen opgevraagd worden:

KadastraalOnroerendeZaak

  • Opvragen van 1 specifiek kadastraalonroerendezaak resource o.b.v. een kadastraalonroerendezaakidentificatie.
  • Opvragen van 1 specifiek kadastraalonroerendezaak resource o.b.v. een kadastraleaanduiding.
  • Opvragen van een collectie kadastraalonroerendezaak resources o.b.v. een adres (postcode, huisnummer, huisletter, huisnummertoevoeging).
  • Opvragen van een collectie kadastraalonroerendezaak resources, waarbij een kadaster natuurlijk persoon rechthebbende is, o.b.v. een kadasterpersoonidentificatie.
  • Opvragen van een collectie kadastraalonroerendezaak resources, waarbij een kadaster nietnatuurlijk persoon rechthebbende is, o.b.v. een kadasterpersoonidentificatie.
  • Opvragen van een collectie kadastraalonroerendezaak resources, waarbij een ingeschreven natuurlijk persoon rechthebbende is, o.b.v. een burgerservicenummer.

ZakelijkGerechtigde

  • Opvragen van een collectie zakelijkgerechtigde resources van 1 specifiek kadastraalonroerendezaak o.b.v. een kadastraalonroerendezaakidentificatie.
  • Opvragen van 1 specifiek zakelijkgerechtigde resource o.b.v. een zakelijkgerechtigdeidentificatie.

KadasterNatuurlijkPersoon

  • Opvragen van 1 specifiek kadaster natuurlijk persoon resource o.b.v. een kadasterpersoonidentificatie.
  • Opvragen van een collectie kadaster natuurlijkpersoon resources o.b.v. een zoekterm. (Zie feature zoeken kadasternatuurlijkpersoon)

KadasterNietNatuurlijkPersoon

  • Opvragen van 1 specifiek kadaster nietnatuurlijk persoon resource o.b.v. kadasterpersoonidentificatie.
  • Opvragen van een collectie kadaster nietnatuurlijk persoon resources o.b.v. een zoekterm. (Zie feature zoeken kadasternietnatuurlijkpersoon)

Hypotheek

  • Opvragen van 1 specifiek hypotheek resource o.b.v. hypotheekidentificatie en kadastraalonroerendezaakidentificatie.
  • Opvragen van een collectie hypotheek resources behorende bij een kadastraal onroerende zaak o.b.v. een kadastraalonroerendezaakidentificatie.

Beslag

  • Opvragen van 1 specifiek beslag resource o.b.v. beslagidentificatie en kadastraalonroerendezaakidentificatie.
  • Opvragen van een collectie beslag resources behorende bij een kadastraal onroerende zaak o.b.v. een kadastraalonroerendezaakidentificatie.

PrivaatrechtelijkeBeperking

  • Opvragen van 1 specifiek privaatrechtelijkebeperking resource o.b.v. privaatrechtelijkebeperkingidentificatie en kadastraalonroerendezaakidentificatie.
  • Opvragen van een collectie privaatrechtelijkebeperking resources behorende bij een kadastraal onroerende zaak o.b.v. een kadastraalonroerendezaakidentificatie.

PrubliekrechtelijkeBeperking

  • Opvragen van een collectie publiekrechtelijkebeperking resources o.b.v. een kadastraalonroerendezaakidentificatie.

Algemeen

Verder zijn er nog een paar algemene functies die gelden voor alle bovenstaande aanvragen:

  • Gebruik van de fields parameter om de response te filteren. (Voor werking, zie feature fields)
  • Gebruik van de expand parameter om subresources te ontsluiten. (Voor werking, zie feature expand)
  • Velden die altijd worden geleverd. (Voor werking, zie feature levering velden)
Resource Velden
KadastraalOnroerendeZaak identificatie, type, _links.self
ZakelijkGerechtigde identificatie, _links.self
KadasterNatuurlijkPersoon identificatie, _links.self
KadasterNietNatuurlijkPersoon identificatie, _links.self
Beslag identificatie, _links.self
hypotheek identificatie, _links.self
KadasterNietNatuurlijkPersoon identificatie, _links.self
PrivaatrechtelijkeBeperking identificatie, _links.self
PubliekrechtelijkeBeperking identificatie
  • Combinatie van velden die altijd verplicht worden geleverd.
Resource Velden Uitleg
KadastraalOnroerendeZaak koopsom & koopjaar & (aardCultuurBebouwd of aardCultuurOnBebouwd) levering koopsom

Bouw de API

We hebben client code voor API-clients in enkele varianten. Hiermee kan je direct aan de slag met het gebruiken van de API.

Zit jouw gewenste ontwikkelomgeving er niet bij, dan kan je zelf ook code genereren vanuit de “genereervariant” van de API-specificaties.

Probeer en test de API

De werking van de API is het makkelijkst te testen met behulp van Postman. We hebben al een project voor je gemaakt die je kan gebruiken: BRK-Bevragen-postman-collection.json. Hierin moet je alleen de endpoints en authenticatie (API-key) nog invullen. We hebben al een Postman collection voor je klaargezet. Deze kun je importeren in Postman.

Configureer de url en api key

  1. Klik bij “Kadaster - BRK-Bevragen API” op de drie bolletjes.
  2. Klik vervolgens op Edit
  3. Selecteer tabblad “Authorization”
  4. Kies TYPE “API Key”
  5. Vul in Key: “x-api-key”, Value: de API key die je van het Kadaster hebt ontvangen, Add to: “Header”
  6. Selecteer tabblad “Variables”
  7. Vul bij baseUrl INITIAL VALUE en bij CURRENT VALUE de url
  8. Klik op de knop Update

De testomgeving van de API is te benaderen via de volgende urls:

  • Beveiligde verbinding met alleen API-key: https://api.brk.kadaster.nl/esd-eto-apikey/bevragen/v1/
    • Voor deze connectie met de testomgeving van deze API is vereist:
      • Een geldige API-key. Deze wordt bij de request opgenomen in request header “X-Api-Key”. Wanneer je je aanmeldt voor het gebruiken van de API ontvang je de API-key.
  • Beveiligde verbinding met API-key & mTLS: https://api.brk.kadaster.nl/esd-eto/bevragen/v1/
    • Voor deze connectie met de testomgeving van deze API is vereist:
      • Een geldige API-key. Deze wordt bij de request opgenomen in request header “X-Api-Key”. Wanneer je je aanmeldt voor het gebruiken van de API ontvang je de API-key.
      • Internet toegang tot het Kadaster endpoint via IPv4 of IPv6 en met het TLS 1.2 protocol.
      • Een Staat der Nederlanden root CA - G3 certificaat in de truststore, zie hiervoor: https://www.pkioverheid.nl/
      • Een geldig PKIoverheid client certificaat met SERIALNUMMER= in de keystore dat deel uitmaakt van de Staat der Nederlanden - G3 hiërarchie, zie hiervoor: https://www.logius.nl/diensten/pkioverheid
      • Een mutual TLS endpoint configuratie, waarbij de TLS verbinding met het Kadaster alleen tot stand mag en kan komen als er bij het opzetten van de verbinding een wederzijds vertrouwen op basis van de PKIoverheid certificaten hiërarchie bestaat.

Testgevallen

Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de werking van de API kan worden getest op de test omgeving.

Onroerende Zaken

Testgeval Kadastraalobjectidentificatie / Kadastraleaanduiding Postcode Bijzonderheden
2 eigenaren (Kadaster Natuurlijk Persoon) 76870487970000
Beekbergen:87 K 4879 		7361EW 29
  • alle velden gevuld
  • 1x hypotheek
  • 2x publiekrechtelijke beperking
  • 1x privaatrechtelijke beperking
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 76870488070000
Beekbergen:87 K 4880 		7361EW 27
  • 1x privaatrechtelijke beperking
1 eigenaar (Kadaster Natuurlijk Persoon) 76870482670000
Beekbergen:87 K 4826 		7361EW 25
  • 2x hypotheek
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 76870482570000
Beekbergen:87 K 4825 		7361EW 21
  • 2 erfpachters met erfpachtcanon
  • 1x hypotheek
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22310827210003
's Gravenhage:881 N 8272 3		 2517GL 84
  • appartementsrecht
  • 1x hypotheek
  • 1x publiekrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22310827210004
's Gravenhage:881 N 8272 4		 2517GL 85
  • appartementsrecht
1 eigenaar (Ingeschreven Natuurlijk Persoon) 56020234070000
Odoorn:717 N 2340 		9573PA 3
  • 1 artikel5_3b
  • 1x hypotheek
1 eigenaar (Ingeschreven Natuurlijk Persoon) 23280647970000
Loosduinen:561 H 6479 		2551XS 31
2551XN 45
2551XN 47
2551XN 49
2551XN 51
  • meerdere adressen
  • 1x privaatrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 65490485370000
Hellendoorn:395 G 4853 		7441JC 1 a
  • bevat huisletter
2 eigenaren (Ingeschreven & Kadaster Natuurlijk Persoon) 65490485270000
Hellendoorn:395 G 4853 		7441JC 1
1 eigenaar (Ingeschreven Natuurlijk Persoon) 24780711870000
Voorschoten:1040 B 7118 		2252EB 14
2252EB 14 B
2252EB 14 C
2252EB 14 D
2252EB 16
2252EB 18
  • meerdere adressen
  • betrokkenGorzenEnAanwassen
1 eigenaar (Ingeschreven Natuurlijk Persoon) 17150075470000
Hellevoetsluis:396 E 754 		3224EA 39
  • 1x hypotheek
  • 1x beslag
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 22590043870000
's Gravenhage:881 AW 438 		2545NN 178
2545NN 180
2545NN 182
  • 1 erfpachter
  • meerdere adressen
  • betrokkenSamenwerkingsverband
  • 2x privaatrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 17500393970000
IJsselmonde:459 D 3939 		3078JG 4
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22360467970000
's Gravenhage:881 V 4679 		2597LD 58
  • 1 erfpachter
  • 1x publiekrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 19560032970000
Rotterdam:841 AF 329 		3011KD 70
3011KD 72
  • meerdere adressen
  • 2x hypotheek
  • 2x publiekrechtelijke beperking
2 eigenaren (Ingeschreven Natuurlijk Persoon) 17550448670000
Kralingen:501 C 4486 		3066VS 9
  • betrokkenPartner
  • 1x hypotheek

Kadaster Natuurlijke Personen

NaamGeboortedatumKadasterPersoonIdentificatieBijzonderheden
Willem Jansens1971-11-0170882239
  • alle velden gevuld
  • woonadres is niet bekend in BAG
Sidonia Jansens1950-01-0150550743
  • buitenlands woonadres
Christaan Goede1971-11-0171303564
  • woonadres is wel bekend in BAG
Anne Janssens80000001
  • geslacht onbekend
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
Jan Groenen80000002
  • aanduiding: eigen geslachtsnaam
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
Susan in het Veld80000003
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner na eigen geslachtsnaam
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
Petra Anne Veldwijk80000004
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
H Pieters80000005
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner voor eigen geslachtsnaam
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
Öle Klaassen80000006
  • diakriet in voornaam
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=
Baron Jan-Jaap de Vierde80000007
  • adellijke titel
  • kan niet op gezocht worden via /kadasternatuurlijkpersonen?q=

Ingeschreven Natuurlijke Personen

NaamBurgerservice-nummer
Linda Haglund999991905
Lisanty do Livramento...999990482
Merel Kooyman999993847
Suzanne van der Stappen999993653
Mirjam Heijn999991292
Jael de Jager999992740
Wladyslaw Kwasniewski999995017
Żáïŀëñøŕ Åłéèç Ðëļŧå Streeveld999994669
Adrianus Hendrikus Holthuizen999990421
Peter-Jan Meijden999993872
Paul Man999990883

Niet Natuurlijke Personen

Statutaire Naam Zetel Type KadasterPersoonIdentificatie Bijzonderheden
Bankbedrijf ROTTERDAM Kadaster Niet Natuurlijk Persoon 71291440
  • postadres is postbus
Bankbedrijf van vrucht GRAVE Ingeschreven Niet Natuurlijk Persoon71291493
  • heeft niks op naam
Gasunie Test BV GRONINGEN Ingeschreven Niet Natuurlijk Persoon440650207
Gemeente Den Testland 'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 71291441
  • kan niet op gezocht worden via /kadasternietnatuurlijkpersonen?q=
Woningstichting Den Testland'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 71291442
  • kan niet op gezocht worden /kadasternietnatuurlijkpersonen?q=

Foutscenarios

Aanvraag Foutscenario
/kadastraalonroerendezaken/122003147000 404 Not found
/kadastraalonroerendezaken/122003157000 410 Gone

Aansluiten op productie

Voor de connectie met de productieomgeving van deze API is vereist:

  • Een geldige API-key. Deze wordt bij de request opgenomen in request header “X-Api-Key”. Wanneer je je aanmeldt voor het gebruiken van de API ontvang je de API-key.
  • Internet toegang tot het Kadaster endpoint via IPv4 of IPv6 en met het TLS 1.2 protocol.
  • Een Staat der Nederlanden root CA - G3 certificaat in de truststore, zie hiervoor: https://www.pkioverheid.nl/
  • Een geldig PKIoverheid client certificaat met SERIALNUMMER= in de keystore dat deel uitmaakt van de Staat der Nederlanden - G3 hiërarchie, zie hiervoor: https://www.logius.nl/diensten/pkioverheid
  • Een mutual TLS endpoint configuratie, waarbij de TLS verbinding met het Kadaster alleen tot stand mag en kan komen als er bij het opzetten van de verbinding een wederzijds vertrouwen op basis van de PKIoverheid certificaten hiërarchie bestaat.

URL

De productieomgeving van de API is te benaderen via de volgende url: https://api.brk.kadaster.nl/esd/bevragen/v1/