docs-Documentatie

Overzicht

Overview

Snelstart

Quickstart

Test de API's

Testing the APIs

Release Notes

Certificaten

Certificates

docs-API Referentie

Zoeken API

Basisprofiel API

Vestigingsprofiel API

Naamgeving API

Mutatieservice API

docs-Open data

Open Dataset Basis Bedrijfsgegevens

Open dataset Jaarrekeningen

intro

<p>A KVK API functions as an interface between your software applications and the KVK Business Register. It allows the two to communicate with each other. An API key gives you access to information in the Business Register.</p>

why use

<h2>Why use the KVK API?</h2><ul><li><strong>Autofill</strong>: You can directly retrieve current information from the Business Register within your own CRM system, website or financial package. The data will be automatically supplemented (prefill).</li><li><strong>Validity check</strong>: You can check business customers on KVK number, address details, SBI and working people</li></ul><h2 id="available-apis">Available APIs</h2><h3>KVK Handelsregister Zoeken</h3><p>You can use the Zoeken API to retrieve the KVK number of a registration.</p><h3>KVK Handelsregister Basisprofiel</h3><p>Look up basic information of registrations with the KVK number. For example, social activity, details of owner/main location, and a list of locations.</p><h3>KVK Handelsregister Vestigingsprofiel</h3><p>Look up specific information of registrations with the location number. For example basic information, business activities and physical and postal address.</p><h3>KVK Handelsregister Naamgeving</h3><p>Use the KVK number to retrieve trade names from a registration. For example statutory name, trade names and non-commercial name.</p>

using the api's

<h2 id="using-the-apis">Using the APIs</h2><p>Only the KVK Zoeken API delivers multiple results, the other APIs all return a single result. If a search with Basisprofiel, Vestigingsprofiel or Naamgeving results in multiple registrations, the first result will be shown. Therefore, we recommend using a combination of fields to make your search in the Zoeken API as specific as possible. For instance you could combine</p><ul><li>KVK number and branch number (vestigingsnummer).</li><li>KVK number and RSIN number (RSIN: Rechtspersonen en Samenwerkingsverbanden Informatienummer - Legal Entities and Partnerships Identification Number)</li><li>KVK number and type (branch, main branch, and/or legal entity)</li></ul><p>For free format search, the other input parameters (e.g. trade name, street name, etc.) can be used.</p>

datamodel

<h2 id="data-model">Data model</h2><p>The Zoeken API contains 2 separate entities that differ in their property "type":</p><ul><li>Branch</li><li>Legal entity</li></ul><h3>Example of legal entity in Zoeken API</h3><div class="jsx-3943413509"><pre><code class="language-json">{
  "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&amp;pagina=1&amp;resultatenperpagina=10"
    }
  ]
}
</code></pre></div><h3>Example of type branch in Zoeken API</h3><div class="jsx-3943413509"><pre><code class="language-json">{
  "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&amp;pagina=1&amp;resultatenperpagina=10"
    }
  ]
}
</code></pre></div>

HATEOAS

<h2 id="hateoas">HATEOAS</h2><p>The Zoeken API offers the possibility to search for company data, location data and/or legal entities. The Basispofiel and Vestigingsprofiel APIs are linked to the Zoeken API. Search results contain URLs to the related Basisprofiel en Vestigingsprofiel resources. Within REST this is also known as HATEOAS. We used the HAL standard for these APIs to implement HATEOAS.</p><h2 id="results">Results</h2><ul><li>Registrations that are no longer active are not shown in the results by default.</li><li>Search works on whole-text d-matching. For example, "koophand" has zero results while "koophandel" has about 1,000 results.</li><li>The KVK Zoeken API displays a maximum of 100 results per page (default = 10 results per page).</li><li>The API does not guarantee that the results are in order (branches or legal entities). But there is a preference for sorting by headquarters, branches, legal entity.</li></ul><h2 id="output-standard">Output standard</h2><p>An http GET-request is the only allowed http request. The KVK APIs use the standard JSON object (JavaScript Object Notation) as output. This facilitates generic results for the API output. It also contains a number of metadata elements that are included with every JSON output (page, count, total, next and previous). We use the specifications prescribed by JSON.org. However, there are 2 very specific features related to the KVK API JSON output:</p><h3 id="registration-date">Registratiedatum</h3><p>The date registered in the Business Register can contain zeros as the date is unknown. If the full date is known then the format is: YYYYMMDD (year/month/day). Only numeric values are allowed (including 0 for unknown parts of the date).<br>For example:</p><ul><li>complete date: 20150622</li><li>day unknown: 20150600</li><li>month unknown: 20150000</li><li>date unknown : 00000000</li></ul><h3 id="geo-data">Geo-data</h3><p>GEO data is geographic data used to determine the location of addresses and buildings to indicate. Using the BAG IDs (addressableObjectId and numberIndicationId) can be entered in the BAG (Basic Registration Addresses and Buildings) are searched for, among other things, surface area and purpose of use.<br>Geo-data is retrieved by including an extra parameter “?geoData=true” in the call to location profiles. By default, this parameter is set to false. The coordinates are only provided if they are known (for PO boxes for example, this will be empty).</p><p>Example of GEO-data as part of an address:</p><pre><code class="language-json">{
  "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
      }
    }
  ]
}</code></pre>

Statuscodes

<h2 id="status-codes">Status codes</h2><p>If there is an error message and/or error handling occurs, normal http status codes and messages used. Error messages and error handling use the following non-exhaustive list of error codes:</p><ul><li>400 - Bad request</li><li>401 - Not authenticated</li><li>404 - Not found</li><li>500 - Internal server error</li></ul><h3>IPD codes</h3><figure class="table"><table><thead><tr><th>Code</th><th>Description</th><th>Http status</th></tr></thead><tbody><tr><td><span>IPD0001</span></td><td><span>The requested product {0} does not exist.</span></td><td><span>404</span></td></tr><tr><td><span>IPD0004</span></td><td><span>The KVK number {0} is not valid</span></td><td><span>400</span></td></tr><tr><td><span>IPD0005</span></td><td><span>The product cannot be delivered based on the KVK number {0}.</span></td><td><span>404</span></td></tr><tr><td><span>IPD0006</span></td><td><span>The vestigingsnummer (branch number) {0} is not valid.</span></td><td><span>400</span></td></tr><tr><td><span>IPD0007</span></td><td><span>The product cannot be delivered based on vestigingsnummer {0}.</span></td><td><span>404</span></td></tr><tr><td><span>IPD0010</span></td><td><span>The RSIN number {0} is not valid.</span></td><td><span>400</span></td></tr><tr><td><span>IPD1002</span></td><td><span>The data is temporarily unavailable because it is being processed. Please try again later.</span></td><td><span>404</span></td></tr><tr><td>IPD1003</td><td><span>The data is temporarily unavailable. Please try again in 5 minutes.&nbsp;</span></td><td>404</td></tr><tr><td><span>IPD1998</span></td><td><span>General input parameter error.</span></td><td><span>400</span></td></tr><tr><td><span>IPD1999</span></td><td><span>The following specified parameter(s) is(are) invalid: {0}</span></td><td><span>400</span></td></tr><tr><td><span>IPD5200</span></td><td><span>No data was found that matches the specified search parameters.</span></td><td><span>404</span></td></tr><tr><td><span>IPD5203</span></td><td><span>The specified type is not valid.</span></td><td><span>404</span></td></tr><tr><td><span>IPD9999</span></td><td><span>General technical error.</span></td><td><span>500</span></td></tr></tbody></table></figure>

Legal entities output

<h2 id="legal-entities-output">Legal entities output</h2><p>The PDF below contains the information that a search for legal forms yields. Information is in Dutch.</p><ul><li><a href="https://developers.kvk.nl/cms/api/uploads/Lijst_output_rechtsvormen.pdf">Extensive list of output legal forms</a></li></ul><h2 id="foreign-legal-forms">Foreign legal forms</h2><p>The PDF below contains values that can occur with the attribute 'omschrijvingRechtsvorm'. Information is in Dutch.</p><ul><li><a href="https://developers.kvk.nl/cms/api/uploads/Overzicht_buitenlandse_rechtsvormen_uit_Gegevenscatalogus.pdf">Overview of foreign legal forms from data catalog</a></li></ul><h2 id="country-codes">Country codes</h2><p>The PDF below contains the possible values for a country, indicated according to the BRP country table (also known as Table 34). Information is in Dutch.</p><ul><li><a href="https://developers.kvk.nl/cms/api/uploads/Landen_tabel_extract_uit_GC_Enumeratie.pdf">Country table extract from GC Enumeration</a></li></ul>

Hier vind je alle benodigde documentatie om de KVK Handelsregister API te bevragen.

Overzicht API documentatie

Here you will find all the necessary documentation to use the KVK Handelsregister APIs.

Overview API Documentation

title 

introtext

<p>To access the KVK APIs, you need a subscription, which you can request via the Developer Portal. Once approved, you will be connected to the API channel and receive an API key, which you can use to access the APIs.</p>

<p><a class="generic-button" href="/apply-for-apis">Request subscription</a></p>

inbegrepen

<p>With the Zoeken API, you can retrieve the KVK number of a registration. You can then request additional information using one of the other APIs.</p><h3>Technical information</h3><ul><li><a href="/documentation/zoeken-api">Reference input and output</a></li><li><a href="/documentation/testing/swagger-zoeken-api">Swagger UI</a></li></ul>

Zoeken

<p>Look up basic information of registrations with the KVK number. For example, social activity, details of owner and main location, and a list of locations.</p><h3>Technical information</h3><ul><li><a href="/documentation/basisprofiel-api">Reference input and output</a></li><li><a href="/documentation/testing/swagger-basisprofiel-api">Swagger UI</a></li></ul>

Basisprofiel 

<p>Look up specific information of registrations with the branch number. For example basic information, business activities and physical and postal address.</p><h3>Technical information</h3><ul><li><a href="/documentation/vestigingsprofiel-api">Reference input and output</a></li><li><a href="/documentation/testing/swagger-vestigingsprofiel-api">Swagger UI</a></li></ul>

Vestigingsprofiel

<p>Use the KVK number to retrieve trade names from a registration. For example statutory name, trade names and non-commercial name.</p><h3>Technical information</h3><ul><li><a href="/documentation/naamgeving-api">Reference input and output</a></li><li><a href="/documentation/testing/swagger-naamgeving-api">Swagger UI</a></li></ul>

Naamgeving

prent-api-data-toegang-aanvragen.svg

<p>You pay a fixed monthly fee and an amount per query.</p><p><a class="chevron-right--before" href="/pricing">View rates</a></p>

Pricing

prent-api-data-documentatie.svg

<p>Want to know everything about the APIs? Check out our documentation, such as OpenAPI specifications (Swagger UI), release notes, and references.</p><p><a class="chevron-right--before" href="/documentation">View documentation</a></p>

Documentation

prent-api-data-testen.svg

<p>How can we help you? Check out our FAQs for quick answers.</p><p><a class="chevron-right--before" href="/faq">View the frequently asked questions</a></p>

Questions?

Om toegang te krijgen tot de KVK API’s heb je een abonnement nodig. Dit vraag je aan via het Developer Portal. Na goedkeuring word je aangesloten op het API-kanaal en ontvang je een API-key, waarmee je de API’s kunt gebruiken.

API-abonnement

To access the KVK APIs, you need a subscription, which you can request via the Developer Portal. Once approved, you will be connected to the API channel and receive an API key, which you can use to access the APIs.

API-subscription

Included APIs

Zoeken

Technical information

Basisprofiel

Technical information

Vestigingsprofiel

Technical information

Naamgeving

Technical information

Pricing

Pricing

Documentation

Documentation

Questions?

Questions?