Overzicht API documentatie

Hoe gebruik je een KVK API?

KVK Handelsregister Basisprofiel en Vestigingsprofiel leveren maximaal één registratie per verzoek. Als er meerdere registraties zijn, dan wordt het eerste resultaat getoond. Gebruik een combinatie van velden om het zoeken zo specifiek mogelijk te maken. Bijvoorbeeld:

• KVK-nummer en vestigingsnummer
• KVK-nummer en RSIN
• KVK-nummer en type (hoofdvestiging, nevenvestiging en/of rechtspersoon)

Gebruik voor free format zoeken de overige inputparameters (bijvoorbeeld handelsnaam of straatnaam).

Datamodel

De Zoeken API heeft 2 aparte entiteiten die verschillen in de property "type".

• Vestiging
• Rechtspersoon

Voorbeeld rechtspersoon met de Zoeken API:

{
  "pagina": 1,
  "resultatenPerPagina": 10,
  "totaal": 1,
  "resultaten": [
    {
      "kvkNummer": "69599068",
      "naam": "Test Stichting Bolderbast",
      "adres": {
        "binnenlandsAdres": {
          "type": "bezoekadres",
          "straatnaam": "Oosterwal",
          "plaats": "Lochem"
        }
      },
      "type": "rechtspersoon",
      "links": [
        {
          "rel": "basisprofiel",
          "href": "https://api.kvk.nl/test/api/v1/basisprofielen/69599068"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.kvk.nl/test/api/v2/zoeken?kvknummer=69599068&pagina=1&resultatenperpagina=10"
    }
  ]
}
Kopiëren

Voorbeeld vestiging met de Zoeken API:

{
  "pagina": 1,
  "resultatenPerPagina": 10,
  "totaal": 1,
  "resultaten": [
    {
      "kvkNummer": "68750110",
      "vestigingsnummer": "000037178598",
      "naam": "Test BV Donald",
      "adres": {
        "binnenlandsAdres": {
          "type": "bezoekadres",
          "straatnaam": "Hizzaarderlaan",
          "plaats": "Lollum"
        }
      },
      "type": "hoofdvestiging",
      "links": [
        {
          "rel": "basisprofiel",
          "href": "https://api.kvk.nl/test/api/v1/basisprofielen/68750110"
        },
        {
          "rel": "vestigingsprofiel",
          "href": "https://api.kvk.nl/test/api/v1/vestigingsprofielen/000037178598"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.kvk.nl/test/api/v2/zoeken?kvknummer=68750110&pagina=1&resultatenperpagina=10"
    }
  ]
}
Kopiëren

HATEOAS

Met de Zoeken API zoek je naar bedrijfsgegevens, vestigings-gegevens en/of rechtspersonen. De Basisprofiel en Vestigingsprofiel API’s zijn gelinkt aan de Zoeken API. Ze bevatten zoekresultaten URL’s naar de gerelateerde Basisprofiel resource en Vestigingsprofiel resources. Dit is binnen REST ook wel bekend als HATEOAS. We hebben de HAL standard gebruikt om HATEOAS te implementeren.

Resultaten

• Registraties die niet meer actief zijn worden standaard niet getoond in de resultaten.
• Zoeken werkt op gehele tekst d-matching. Bijvoorbeeld: ‘koophand’ geeft nul resultaten en ‘koophandel’ ongeveer 1000.
• De KVK API geeft maximaal 100 resultaten per pagina weer (default = 10 resultaten per pagina).
• Er is geen garantie dat de resultaten op volgorde worden weergegeven (vestigingen en/of rechtspersonen). Maar er is wel een voorkeur voor sortering hoofdvestiging, nevenvestigingen, rechtspersoon.

Output standard

Een http GET-request is de enige toegestane http methode voor de API. Voor de output maken we gebruik van standaard JSON object (JavaScript Object Notation). Dit zorgt voor generieke resultaten. Bij elke JSON output worden ook een aantal metadata elementen geleverd (pagina, aantal, totaal, volgende en vorige).

We gebruiken de specificaties die zijn voorgeschreven door JSON.org. Er zijn echter 2 specifieke kenmerken met betrekking tot de KVK API JSON output: registratiedatum en geodata.

Registratiedatum

De datum geregistreerd in het Handelsregister kan nullen bevatten als de datum onbekend is. Als de volledige datum bekend is dan is het formaat: YYYYMMDD (year/month/day). Alleen numerieke waarden zijn toegestaan (inclusief 0 voor onbekende delen van de datum).

• complete datum: 20150622
• dag onbekend: 20150600
• maand onbekend: 20150000
• datum onbekend: 00000000

Geodata

Geodata zijn geografische gegevens die gebruikt worden om de locatie van adressen en gebouwen aan te geven. Met behulp van de BAG ID’s (addresseerbaarObjectId en nummerAanduidingId) kan in de BAG (Basisregistratie Adressen en Gebouwen) gezocht worden naar onder andere oppervlakte en gebruiksdoel.

Geodata worden opgehaald door de extra parameter “?geoData=true” op te nemen in de aanroep bij vestigingsprofielen. Standaard staat deze parameter op false.

Voorbeeld van geodata als onderdeel van een adres:

{
  "adressen":[
    {
      "type":"bezoekadres",
      "indicatieAfgeschermd":"Nee",
      "volledigAdres":"Watermolenlaan 1 3447GT Woerden",
      "straatnaam":"Watermolenlaan",
      "huisnummer":1,
      "postcode":"3447GT",
      "plaats":"Woerden",
      "land":"Nederland",
      "geoData":{
        "addresseerbaarObjectId":"0632010000010090",
        "nummerAanduidingId":"0632200000010090",
        "gpsLatitude":52.08151653230184,
        "gpsLongitude":4.890048011859921,
        "rijksdriehoekX":120921.45,
        "rijksdriehoekY":454921.47,
        "rijksdriehoekZ":0
      }
    }
  ]
}
Kopiëren