Manual API

Handleiding API

You will find all information about the Chamber of Commerce APIs in the API Manual. Like how to use them, information about standards and data models, possible output for legal forms and possible error codes.  

Download the document below.

In de Handleiding API vind je alle informatie over de KVK API's. Bijvoorbeeld hoe je ze gebruikt, informatie over standaarden en datamodellen, mogelijke output voor rechtsvormen en mogelijke foutcodes.
  
Download hieronder het document.

Handleiding TLS-certificaat

Manual TLS-certificate

## Input
The input query can be constructed from one or more (combinations of) the following parameters:
- KVK-nummer (KVK number)
- RSIN (Legal Entities and Partnerships Identification Number)
- Vestigingsnummer (Establishment number)
- Handelsnaam (Trade name)
- Straatnaam (Street name)
- Postcode en huisnummer (Postal code and House number)
- Huisnummertoevoeging (house number addition is optional)
- Plaats (Place)  
- Type (Filter per type: headquarters, branch or legal person)
- Inclusief inactieve registraties (Including inactive registrations with possible values True or False.
Default value is False.)
- Pagina (Page, default value : 1)
- Aantal (Number of results per page, default value : 10, maximum: 100)  
  
## Output
- Pagina (Page)
- Aantal (Number)
- Totaal (Total)
- Link naar Vorige pagina (link to previous page)
- Link naar Volgende pagina (link to next page)  
- **Resultaten**
  - KVK-nummer (KVK number)
  - Vestigingsnummer (Establishment number)
  - RSIN (only shown when RSIN used as input)
  - Handelsnaam (Trade name)
  - Straatnaam (Street name)
  - Huisnummer (House number, only shown when used as input)
  - Postcode (Postal code, only shown when used as input)
  - Plaats (Place)
  - Type (Type)
  - Actief (Active)  
  - **Links**
    - Link to first search result: _self
    - Link to Basisprofiel (link to KVK Handelsregister basisprofiel based on the KVK-number)
    - Link to Vestigingsprofiel (link to KVK Handelsregister vestigingsprofiel based on the Establishment number)  

    If deregistration has taken place before May 22, 2010 then there will be no links shown.

## Input
De inputquery kan opgebouwd worden uit één of meerdere (combinaties van) onderstaande parameters:
- KVK-nummer
- RSIN
- Vestigingsnummer
- Handelsnaam (waaronder actieve of vervallen statutaire naam, handelsnaam of naam)
- Straatnaam
- Postcode en huisnummer (huisnummertoevoeging is optioneel)
- Plaats  
- Type (Filter bij type: hoofdvestiging, nevenvestiging of rechtspersoon)
- Inclusief inactieve registraties met mogelijke waarden zijn “True” of “False”. Default waarde is “False”
- Pagina (Standaardwaarde : 1)
- Aantal (Aantal resultaten per pagina Standaardwaarde : 10, maximaal: 100)  

## Output   
- Pagina
- Aantal
- Totaal
- Link naar Vorige pagina
- Link naar Volgende pagina
- **Resultaten**
  - KVK-nummer
  - Vestigingsnummer
  - RSIN (indien RSIN ook inputparameter is)
  - Handelsnaam (waaronder actieve of vervallen statutaire naam, handelsnaam of naam)
  - Straatnaam
  - Huisnummer (indien postcode en huisnummer ook inputparameters zijn)
  - Postcode (indien postcode en huisnummer ook inputparameters zijn)
  - Plaats
  - Type  
  - Actief
  - **Links**
    - Link naar eerste zoekresultaat (_self)
    - Link naar Basisprofiel (link naar basisprofiel op basis van KVK-nummer)
    - Link naar Vestigingsprofiel (link naar vestigingsprofiel op basis van Vestigingsnummer)
  
    Als uitschrijving voor 22 mei 2010 heeft plaats gevonden en indien “actief” “False” is dan worden er geen links getoond

Factsheet Zoeken API

The factsheet contains the input and output values of the Zoeken API. 

In de factsheet staan de input en output waarden van de Zoeken API. 

## Input
- KVK-nummer (KVK number)  
- Geodata (Default value is “False”)  

## Output

**Informatie maatschappelijke activiteit (Information business activity)** 
- KVK-nummer (KVK number)
- Non-Mailing-Indicator
- Naam (Name)
- Registratiedatum (Date of registration)
- Datum aanvang (Start date)
- Datum einde (End date)
- Totaal aantal werkzame personen (Total number of employed persons)
- Statutaire naam (Name given in the articles)
- Handelsnamen: naam en volgorde (Trade names: name and order)
- SBI-activiteiten: code, omschrijving en indicator hoofdactiviteit (SIC code: code, description and
indicator main activity)
- **Links**
  - Link to Basisprofiel (link to KVK Handelsregister basisprofiel based on the KVK-number): _self
  - Link to a list of all branches
  
**Informatie hoofdvestiging (Information headquarters)**  
- Vestigingsnummer (Establishment number)
- RSIN (Legal Entities and Partnerships Identification Number)
- KVK-nummer (KVK Number)
- Non-Mailing-Indicator
- Registratiedatum (Date of registration)
- Datum aanvang (Start date)
- Datum einde (End date)
- Eerste handelsnaam (First trade name)
- Indicator hoofdvestiging (Indicator headquarter)
- Indicator commerciële vestiging (Indicator commercial establishment)
- Aantal voltijd werkzame personen (Number of full-time employed persons)
- Totaal aantal werkzame personen (Total number of employed persons)
- Aantal deeltijd werkzame personen (Number of part-time employed persons)
- **Handelsnamen: naam en volgorde (Trade names: name and order)**
- **Adressen (Adresses)**
  - Type adres: correspondentieadres of bezoekadres (Type of address: correspondence address or visiting address)
  - Indicator afgeschermd adres (Indicator protected address)
  - Volledig adres (Full address)
- **Binnenlands adres: (domestic address)**
  - Straatnaam (Street name)
  - Huisnummer (House number)
  - Huisnummertoevoeging (House number addition)
  - Huisletter (House letter)
  - Toevoeging adres (Address addition)
  - Postcode (Postal code)
  - Postbusnummer (Mailbox number)
  - Plaats (Place)
- **Geodata (if parameter “true”)**
  - BAG Identifiers
  - GPS Coordinates
  - ‘Rijksdriehoek’-coordinates
- **Buitenlands adres (Foreign address)**
  - Straat huisnummer (Street House number)
  - Postcode woonplaats (Postal code Place)
  - Regio (Region)
  - Land (Country)
- Websites (Websites)
- **Links**
  - Link to the headquarter: _self
  - Link to a list of all branches  


**Eigenaar (Owner)**
- RSIN (Legal Entities and Partnerships Identification Number)
- Uitgebreide rechtsvorm (Extended legal form)
- Rechtsvorm (legal form)
- Adressen (Adresses, only if no headquarters available)
- **Links**
  - Link to the owner: _self
  - Link to a list of all branches

## Input
- KVK-nummer  
- Geodata (Default waarde is False)  

## Output
**Informatie Maatschappelijke activiteit**
- KVK-nummer
- RSIN
- Non-Mailing-Indicator
- Naam
- Registratiedatum
- Datum inschrijving
- Datum uitschrijving
- Totaal aantal werkzame personen
- Statutaire naam
- Handelsnamen (naam en volgorde)
- SBI-activiteiten (code, omschrijving en indicator hoofdactiviteit)
- **Links**
    - Link naar het basisprofiel (_self)
    - Link met een lijst van alle vestigingen

**Informatie hoofdvestiging**
- Vestigingsnummer
- KVK-nummer
- Non-Mailing-Indicator
- Registratiedatum
- Datum inschrijving
- Datum uitschrijving
- Eerste handelsnaam
- Indicator hoofdvestiging
- Indicator commerciële vestiging
- Aantal voltijd werkzame personen
- Totaal aantal werkzame personen
- Aantal deeltijd werkzame personen
- Handelsnamen (naam en volgorde)
- **Adressen**
    - Type adres (correspondentieadres of bezoekadres)
    - Indicator afgeschermd adres
    - Volledig adres
- **Binnenlands adres:**
    - Straatnaam
    - Huisnummer
    - Huisnummertoevoeging
    - Huisletter
    - Toevoeging Adres
    - Postcode
    - Postbusnummer
    - Plaats
- **Geodata (if parameter “true”)**
    - BAG Identifiers
    - GPS Coordinates
    - Rijksdriehoek’-coordinates
- **Buitenlands adres**
    - Straat huisnummer
    - Postcode woonplaats
    - Regio
    - Land
- Websites
- **Links**
    - Link naar de hoofdvestiging (_self)
    - Link naar lijst met alle vestigingen

**Eigenaar**
- RSIN
- Uitgebreide rechtsvorm
- Rechtsvorm
- Adressen (Alleen indien er geen vestiging aanwezig is)
- Websites (Alleen indien er geen vestiging aanwezig is)
- **Links**
    - Link van de eigenaar (_self)
    - Link naar lijst met alle vestigingen




Factsheet Basisprofiel API

The factsheet contains the input and output values of the Basisprofiel API. 

In de factsheet staan de input en output waarden van de Basisprofiel API. 

## Input  
- Vestigingsnummer (Establishment number)
- Geodata (Default value is “False”)  

## Output  
**Vestiging (Establishment)**
- Vestigingsnummer (Establishment number)
- KVK-nummer (KVK number)
- RSIN (Legal Entities and Partnerships Identification Number)
- Non-Mailing-Indicator
- Registratiedatum (Date of registration)
- Datum aanvang (Start date)
- Datum einde (End date)
- Eerste handelsnaam (First trade name)
- Indicator hoofdvestiging (Indicator headquarter)
- Indicator commerciële vestiging (Indicator commercial establishment)
- Aantal voltijd werkzame personen (Number of full-time employed persons)
- Totaal aantal werkzame personen (Total number of employed persons)
- Aantal deeltijd werkzame personen (Number of part-time employed persons)
- Handelsnamen: naam en volgorde (Trade names: name and order)
- **Adressen (Adresses)**
  - Type adres: correspondentieadres of bezoekadres (Type of address: correspondence address or visiting address)
  - Indicator afgeschermd adres (Indicator protected address)
  - Volledig adres (Full address)
- **Binnenlands adres: (domestic address)**
  - Straatnaam (Street name)
  - Huisnummer (House number)
  - Huisnummertoevoeging (House number addition)
  - Huisletter (House letter)
  - Toevoeging adres (Address addition)
  - Postcode (Postal code)
  - Postbusnummer (Mailbox number)
  - Plaats (Place)


- **Geodata (if parameter “true”)**
  - BAG Identifiers
  - GPS Coordinates
  - ‘Rijksdriehoek’-coordinates
- **Buitenlands adres (Foreign address)**
  - Straat huisnummer (Street House number)
  - Postcode woonplaats (Postal code Place)
  - Regio (Region)
  - Land (Country)
- Websites (Websites)
- SBI-activiteiten: code, omschrijving en indicator hoofdactiviteit (SIC code: code, description and indicator main activity)
- Links
  - Link to this establishment: _self
  - Link to Basisprofiel (link to KVK Handelsregister basisprofiel based on KVK-number)

## Input
- Vestigingsnummer  
- Geodata (Default waarde is False)  

## Output
**Vestiging**
- Vestigingsnummer
- KVK-nummer
- RSIN
- Non-Mailing-Indicator
- Registratiedatum
- Datum inschrijving
- Datum uitschrijving
- Eerste handelsnaam
- Indicator hoofdvestiging
- Indicator commerciële vestiging
- Aantal voltijd werkzame personen
- Totaal aantal werkzame personen
- Aantal deeltijd werkzame personen
- Handelsnamen (naam en volgorde)
- **Adressen**
    - Type adres (correspondentieadres of bezoekadres)
    - Indicator afgeschermd adres
    - Volledig adres
    - **Binnenlands adres:**
        - Straatnaam
        - Huisnummer
        - Huisnummertoevoeging
        - Huisletter
        - Toevoeging Adres
        - Postcode
        - Postbusnummer
        - Plaats
    - **Geodata:**
        - BAG ID’s
        - GPS-coördinaten
        - Rijksdriehoek-coördinaten
    - **Buitenlands adres**
        - Straat huisnummer
        - Postcode woonplaats
        - Regio
        - Land
- Websites
- SBI-activiteiten (code, omschrijving en indicator hoofdactiviteit)
- **Links**
    - Link van deze vestiging (_self)
    - Link naar Basisprofiel (link naar API Basisprofiel op basis van KVK-nummer)


Factsheet Vestigingsprofiel API

The factsheet contains the input and output values of the Vestigingsprofiel API. 

In de factsheet staan de input en output waarden van de Vestigingsprofiel API. 

Factsheet Vestigingsprofiel API v1.4

Input

Output