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. Aanmelden bij het kadaster om toegang te krijgen
  2. Bekijk de functionaliteit en specificaties
  3. Implementeer de API Client
  4. Probeer en test de API
  5. Aansluiten op productie

Aanmelden

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 1 specifiek kadastraalonroerendezaak resource o.b.v. een nummeraanduidingIdentificatie.
  • 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.

PubliekrechtelijkeBeperking

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

Stuk

  • Opvragen van 1 specifiek stuk resource o.b.v. stukidentificatie.

Stukdeel

  • Opvragen van 1 specifiek stukdeel resource o.b.v. stukdeelidentificatie.

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, _links.self, type, domein
ZakelijkGerechtigde identificatie, _links.self, domein
KadasterNatuurlijkPersoon identificatie, _links.self, domein
KadasterNietNatuurlijkPersoon identificatie, _links.self, domein
Beslag identificatie, _links.self, domein
hypotheek identificatie, _links.self, domein
KadasterNietNatuurlijkPersoon identificatie, _links.self, domein
PrivaatrechtelijkeBeperking identificatie, _links.self, domein
PubliekrechtelijkeBeperking identificatie, domein
Stuk identificatie, _links.self, domein
Stukdeel identificatie, _links.self, domein
  • Combinatie van velden die altijd verplicht worden geleverd.
Resource Velden Uitleg
KadastraalOnroerendeZaak koopsom & koopjaar & (aardCultuurBebouwd of aardCultuurOnBebouwd) levering koopsom

Implementeer de API client

Client code kun je genereren met de “genereervariant” van de API-specificaties en een code generator. Een overzicht met codegeneratoren kun je vinden op OpenAPI.Tools.

Deze repo bevat scripts waarmee je met OpenAPI Generator client code kunt genereren in JAVA, .NET (Full Framework & Core) en Python. De makkelijkste manier om de code generatie scripts te gebruiken, is door deze repo te clonen. Na het clonen kun je met npm install de benodigde packages installeren en kun je met npm run

  • oas:generate-java-client (voor JAVA client code)
  • oas:generate-netcore-client (voor .NET Core client code)
  • oas:generate-net-client (voor .NET Full Framework client code)
  • oas:generate-python-client (voor Python client code)

Een lijst met andere ondersteunde generator opties kun je vinden in de Generators List van OpenAPI Generator. Note. De prerequisite van OpenAPI Generator is JAVA. Je moet een JAVA runtime installeren voordat je OpenAPI Generator kunt gebruiken.

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/

  • Beveiligde verbinding met API-key & mTLS: https://api.brk.kadaster.nl/esd-eto/bevragen/v1/

Vraag hiervoor een API-key en PKI-overheidscertificaat aan.

Testgevallen

Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de werking van de API kan worden getest op de test omgeving. Meer details over welke testdata in de testgevallen zit, vind je in test cases

Onroerende Zaken

Testgeval Kadastraalobjectidentificatie / Kadastraleaanduiding Postcode Nummeraanduidingidentificatie Bijzonderheden
2 eigenaren (Kadaster Natuurlijk Persoon) 76870487970000
Beekbergen K 4879
7361EW 29 0200200000003734
  • alle velden gevuld
  • 1x hypotheek
  • 2x publiekrechtelijke beperking
  • 1x privaatrechtelijke beperking
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 76870488070000
Beekbergen K 4880
7361EW 27 0200200000003733
  • 1x privaatrechtelijke beperking
1 eigenaar (Kadaster Natuurlijk Persoon) 76870482670000
Beekbergen K 4826
7361EW 25 0200200000003732
  • 2x hypotheek
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 76870482570000
Beekbergen K 4825
7361EW 21 0200200000003730
  • 2 erfpachters met erfpachtcanon
  • 1x hypotheek
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22310827210003
's-Gravenhage N 8272 A3
2517GL 84 0518200000842213
  • appartementsrecht
  • 1x hypotheek
  • 1x publiekrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22310827210004
's-Gravenhage N 8272 A4
2517GL 85 0518200000609763
  • appartementsrecht
1 eigenaar (Ingeschreven Natuurlijk Persoon) 56020234070000
Odoorn N 2340
9573PA 3 1681200000000215
  • 1 artikel5_3b
  • 1x hypotheek
1 eigenaar (Ingeschreven Natuurlijk Persoon) 23280647970000
Loosduinen H 6479
2551XS 31
2551XN 45
2551XN 47
2551XN 49
2551XN 51
0518200000781378
  • meerdere adressen
  • 1x privaatrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 65490485370000
Hellendoorn G 4853
7441JC 1 a 0163200000554956
  • bevat huisletter
2 eigenaren (Ingeschreven & Kadaster Natuurlijk Persoon) 65490485270000
Hellendoorn G 4852
7441JC 1 0163200000554954
1 eigenaar (Ingeschreven Natuurlijk Persoon) 24780711870000
Voorschoten B 7118
2252EB 14
2252EB 14 B
2252EB 14 C
2252EB 14 D
2252EB 16
2252EB 18
0626200000001232
0626200000013389
0626200000013390
0626200000013391
0626200000001233
0626200000001234
  • meerdere adressen
  • betrokkenGorzenEnAanwassen
1 eigenaar (Ingeschreven Natuurlijk Persoon) 17150075470000
Hellevoetsluis E 754
3224EA 39 0530200002127363
  • 1x hypotheek
  • 1x beslag
1 eigenaar (Kadaster Niet Natuurlijk Persoon) 22590043870000
's-Gravenhage AW 438
2545NN 178
2545NN 180
2545NN 182
0518200000670296
0518200000603608
0518200000737306
  • 1 erfpachter
  • meerdere adressen
  • betrokkenSamenwerkingsverband
  • 2x privaatrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 17500393970000
IJsselmonde D 3939
3078JG 4 0599200000316239
1 eigenaar (Ingeschreven Natuurlijk Persoon) 22360467970000
's-Gravenhage V 4679
2597LD 58 0518200000436225
  • 1 erfpachter
  • 1x publiekrechtelijke beperking
1 eigenaar (Ingeschreven Natuurlijk Persoon) 19560032970000
Rotterdam AF 329
3011KD 70
3011KD 72
0599200001012571
0599200001012572
  • meerdere adressen
  • 2x hypotheek
  • 2x publiekrechtelijke beperking
2 eigenaren (Ingeschreven Natuurlijk Persoon) 17550448670000
Kralingen C 4486
3066VS 9 0599200000193766
  • betrokkenPartner
  • 1x hypotheek
1 eigenaar (Kadaster Natuurlijk Persoon) 76370602970000
Apeldoorn AC 6029
Filiatie 22310691970000
's-Gravenhage N 6919
  • grondperceel van 22310827210004
Filiatie 59020130970000
Groningen P 1309
  • grondperceel van 59020170810218, 59020170810219, 59020170810593, 59020170810594
Filiatie 59020170670000
Groningen P 1706
  • grondperceel van 59020170810218, 59020170810219, 59020170810593, 59020170810594
Filiatie 59020170810218
Groningen P 1708 A218
Filiatie 59020170810219
Groningen P 1708 A219
Filiatie 59020170810593
Groningen P 1708 A593
Filiatie 59020170810594
Groningen P 1708 A594
Filiatie 59020001970000
Groningen P 19
vervallen perceel
Filiatie 59020001870000
Groningen P 18
vervallen perceel
Filiatie 59020001770000
Groningen P 17
vervallen perceel
Gesplitst zakelijkRecht 59020139970000
Groningen P 1399
recht van erfpacht is gesplitst
Gesplitst zakelijkRecht 59020140010001
Groningen P 1400 A1
Gesplitst zakelijkRecht 59020140010002
Groningen P 1400 A2

Kadaster Natuurlijke Personen

NaamGeboortedatumKadasterPersoonIdentificatieBijzonderheden
Willem Jansens1971-11-0170882239
  • alle velden gevuld
  • woonadres is niet bekend in BAG
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Jansens
Sidonia Jansens-Jan1950-01-0150550743
  • buitenlands woonadres
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Jansens-Jan
Christaan Goede1971-11-0171303564
  • woonadres is wel bekend in BAG
Anne Janssens80000001
  • geslacht onbekend
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Janssens
Jan Groenen80000002
  • aanduiding: eigen geslachtsnaam
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Groenen
Susan in het Veld80000003
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner na eigen geslachtsnaam
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Veld
Petra Anne Veldwijk80000004
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Veldwijk
H Pieters80000005
  • aanduiding: geslachtsnaam echtgenoot/geregistreerd partner voor eigen geslachtsnaam
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Pieters
Öle Klaassen80000006
  • diakriet in voornaam
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Klaassen
Baron Jan-Jaap de Vierde80000007
  • adellijke titel
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Vierde
Piet Wielen80000008
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Wielen
Harry Pier70882250
  • overleden
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Pier
Bep Jansen46299338
  • kan in de testomgeving alleen op gezocht worden via /kadasternatuurlijkpersonen?q=Jansen

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
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Bankbedrijf
Bankbedrijf van vrucht GRAVE Ingeschreven Niet Natuurlijk Persoon71291493
  • heeft niks op naam
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Bankbedrijf van vrucht
Gassie Test B.V. GRONINGEN Ingeschreven Niet Natuurlijk Persoon440650207
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Gassie Test B.V.
Gemeente Den Testland 'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 71291441
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Gemeente Den Testland
Woningstichting Den Testland'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 71291442
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Woningstichting Den Testland
De TestStaat'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 71291443
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=De TestStaat
NederlandscheBanck N.V.'S-GRAVENHAGEKadaster Niet Natuurlijk Persoon 24268006
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=NederlandscheBanck N.V.
Vereniging van eigenaars hoofdsplitsingGRONINGENKadaster Niet Natuurlijk Persoon 419941781
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Vereniging van eigenaars hoofdsplitsing
Vereniging van eigenaars ondersplitsingGRONINGENKadaster Niet Natuurlijk Persoon 552056080
  • kan in de testomgeving alleen op gezocht worden via /kadasternietnatuurlijkpersonen?q=Vereniging van eigenaars ondersplitsing

Aansluiten op productie

Vraag voor het aansluiten op de productie omgeving een API-key en PKI-overheidscertificaat aan.

URL

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