### Test KVK Zoeken API with cURL Source: https://developers.kvk.nl/documentation/testing This snippet demonstrates how to test the KVK Handelsregister Zoeken API using a cURL command. It shows how to make a GET request to the test endpoint, including the necessary API key in the 'apikey' header for authentication. The example searches for entries with the name 'test'. ```curl curl https://api.kvk.nl/test/api/v2/zoeken?naam=test -H "apikey: l7xx1f2691f2520d487b902f4e0b57a0b197" ``` -------------------------------- ### Example KVK Zoeken API Calls Source: https://developers.kvk.nl/documentation/testing These examples illustrate how to construct search queries for the KVK Handelsregister Zoeken API. They demonstrate varying parameters such as 'naam' (name), 'type' (main or subsidiary branch), 'plaats' (city), 'straatnaam' (street name), 'resultatenPerPagina' (results per page), and 'pagina' (page number) to retrieve specific company information. ```url https://api.kvk.nl/test/api/v2/zoeken?naam=test&type=hoofdvestiging&plaats=Veendam&straatnaam=Rietdekkershof ``` ```url https://api.kvk.nl/test/api/v2/zoeken?type=nevenvestiging&resultatenPerPagina=4&pagina=2 ``` -------------------------------- ### Get Company Basic Information Source: https://developers.kvk.nl/documentation/testing/swagger-basisprofiel-api Retrieves basic information for a specific company using its KVK number. ```APIDOC ## GET /v1/basisprofielen/{kvkNummer} ### Description Retrieves basic information for a specific company using its KVK number. ### Method GET ### Endpoint /v1/basisprofielen/{kvkNummer} #### Path Parameters - **kvkNummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **companyName** (string) - The name of the company. - **legalForm** (string) - The legal form of the company. - **registrationDate** (string) - The date the company was registered. #### Response Example ```json { "companyName": "Example BV", "legalForm": "BV", "registrationDate": "2020-01-01" } ``` ``` -------------------------------- ### Get Company Main Establishment Information Source: https://developers.kvk.nl/documentation/testing/swagger-basisprofiel-api Retrieves main establishment information for a specific company using its KVK number. ```APIDOC ## GET /v1/basisprofielen/{kvkNummer}/hoofdvestiging ### Description Retrieves main establishment information for a specific company using its KVK number. ### Method GET ### Endpoint /v1/basisprofielen/{kvkNummer}/hoofdvestiging #### Path Parameters - **kvkNummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **establishmentName** (string) - The name of the main establishment. - **address** (string) - The address of the main establishment. #### Response Example ```json { "establishmentName": "Hoofdkantoor", "address": "Example Avenue 10, Rotterdam" } ``` ``` -------------------------------- ### Example GEO-data in Address (JSON) Source: https://developers.kvk.nl/documentation/index This snippet demonstrates the structure of geo-data within an address object in the KVK API's JSON output. It includes geographical identifiers and coordinates, which are provided when known. ```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 } } ] } ``` -------------------------------- ### Get Company Establishments List Source: https://developers.kvk.nl/documentation/testing/swagger-basisprofiel-api Retrieves a list of establishments for a specific company using its KVK number. ```APIDOC ## GET /v1/basisprofielen/{kvkNummer}/vestigingen ### Description Retrieves a list of establishments for a specific company using its KVK number. ### Method GET ### Endpoint /v1/basisprofielen/{kvkNummer}/vestigingen #### Path Parameters - **kvkNummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **establishments** (array) - A list of establishment objects. - **establishmentName** (string) - The name of the establishment. - **address** (string) - The address of the establishment. #### Response Example ```json { "establishments": [ { "establishmentName": "Hoofdkantoor", "address": "Example Avenue 10, Rotterdam" }, { "establishmentName": "Filiaal Amsterdam", "address": "Example Street 5, Amsterdam" } ] } ``` ``` -------------------------------- ### Retrieve KVK Basisprofiel Sub-Resources Source: https://developers.kvk.nl/documentation/testing These examples demonstrate how to access specific sub-resources within the KVK Basisprofiel API. They allow retrieval of detailed information about the company owner ('eigenaar'), main branch ('hoofdvestiging'), or a list of all branches ('vestigingen') associated with a given KVK number. ```url https://api.kvk.nl/test/api/v1/basisprofielen/90003942/vestigingen ``` ```url https://api.kvk.nl/test/api/v1/basisprofielen/90003942/eigenaar ``` ```url https://api.kvk.nl/test/api/v1/basisprofielen/90003942/hoofdvestiging ``` -------------------------------- ### Get Company Owner Information Source: https://developers.kvk.nl/documentation/testing/swagger-basisprofiel-api Retrieves owner information for a specific company using its KVK number. ```APIDOC ## GET /v1/basisprofielen/{kvkNummer}/eigenaar ### Description Retrieves owner information for a specific company using its KVK number. ### Method GET ### Endpoint /v1/basisprofielen/{kvkNummer}/eigenaar #### Path Parameters - **kvkNummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **ownerName** (string) - The name of the owner. - **address** (string) - The address of the owner. #### Response Example ```json { "ownerName": "Jan Jansen", "address": "Example Street 1, Amsterdam" } ``` ``` -------------------------------- ### Retrieve KVK Basisprofiel by KVK Number Source: https://developers.kvk.nl/documentation/testing This example shows how to retrieve the basic company profile using the KVK Basisprofiel API. It requires a KVK number as a parameter in the URL. The API provides core company information and can also be used to access sub-resources like 'eigenaar' (owner), 'hoofdvestiging' (main branch), and 'vestigingen' (branches). ```url https://api.kvk.nl/test/api/v1/basisprofielen/90003942 ``` -------------------------------- ### Retrieve KVK Naamgeving by KVK Number Source: https://developers.kvk.nl/documentation/testing This example demonstrates how to request company name data from the KVK Business Register using the Naamgeving API. It requires a KVK number to retrieve the associated name information. ```url https://api.kvk.nl/test/api/v1/naamgevingen/kvknummer/24330087 ``` -------------------------------- ### Get Establishment Profile by Vestigingsnummer Source: https://developers.kvk.nl/documentation/testing/swagger-vestigingsprofiel-api Retrieve information for a specific establishment using its unique establishment number (vestigingsnummer). This endpoint is part of the KVK Handelsregister Vestigingsprofiel API. ```APIDOC ## GET /v1/vestigingsprofielen/{vestigingsnummer} ### Description Retrieves information for a specific establishment using its establishment number. ### Method GET ### Endpoint /v1/vestigingsprofielen/{vestigingsnummer} ### Parameters #### Path Parameters - **vestigingsnummer** (string) - Required - The unique identifier for the establishment. ### Request Example ```json { "vestigingsnummer": "000038509504" } ``` ### Response #### Success Response (200) - **establishmentNumber** (string) - The establishment number. - **legalForm** (string) - The legal form of the establishment. #### Response Example ```json { "establishmentNumber": "000038509504", "legalForm": "Eenmanszaak" } ``` ``` -------------------------------- ### Retrieve KVK Vestigingsprofiel by Location Number Source: https://developers.kvk.nl/documentation/testing This example shows how to retrieve a location profile using the KVK Vestigingsprofiel API. It requires a location number (vestigingsnummer) as a parameter in the URL to fetch specific details about a registered branch or establishment. ```url https://api.kvk.nl/test/api/v1/vestigingsprofielen/990000246530 ``` -------------------------------- ### Zoeken API Source: https://developers.kvk.nl/documentation/testing/swagger-zoeken-api This endpoint allows you to search for basic company information using the KVK API. ```APIDOC ## GET /zoeken ### Description Voor een bedrijf zoeken naar basisinformatie. ### Method GET ### Endpoint /zoeken ### Parameters #### Query Parameters (No query parameters specified in the provided text) #### Request Body (Not applicable for GET requests) ### Request Example (Not provided in the text) ### Response #### Success Response (200) (Response fields not detailed in the provided text) #### Response Example (Not provided in the text) ``` -------------------------------- ### Basic Company Information API Source: https://developers.kvk.nl/documentation/open-dataset-basis-bedrijfsgegevens-api Retrieve basic company details using the KVK number. This includes information like registration date, zip code region, and activities. The dataset is limited to Private Companies (BV) and Public Limited Companies (NV) and has a rate limit of 100 queries per 5 minutes. ```APIDOC ## GET /api/v1/hvds/basisbedrijfsgegevens/kvknummer ### Description Retrieves basic company information from the KVK Business Register using a KVK number. ### Method GET ### Endpoint `https://opendata.kvk.nl/api/v1/hvds/basisbedrijfsgegevens/kvknummer` ### Parameters #### Query Parameters - **kvknummer** (string) - Required - The KVK number of the company to look up. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **registrationDate** (string) - The date the company was registered. - **zipCodeRegion** (string) - The region based on the company's zip code. - **activities** (array of strings) - A list of the company's registered activities. #### Response Example ```json { "registrationDate": "2023-01-15", "zipCodeRegion": "Amsterdam", "activities": [ "Software Development", "Consulting" ] } ``` ``` -------------------------------- ### KVK Zoeken API - General Information Source: https://developers.kvk.nl/documentation/index This section provides general information about the KVK Zoeken API, including search behavior and result pagination. ```APIDOC ## KVK Zoeken API ### Description The KVK Zoeken API allows searching for businesses. Results are filtered by default to exclude inactive registrations. Search matches whole words; for example, 'koophand' yields no results, while 'koophandel' does. The API returns a maximum of 100 results per page, with a default of 10. The order of results is not guaranteed but prioritizes headquarters, branches, and legal entities. ### Method GET ### Endpoint /websites/developers_kvk_nl/api/search ``` -------------------------------- ### Error Notification for Unsupported Query Parameters (JSON) Source: https://developers.kvk.nl/documentation/release-notes/basisprofiel-api This JSON structure represents the error notification received when unsupported query parameters are used in an API query. It includes an error code and a description indicating the invalid parameters. This ensures developers receive specific feedback for incorrect API usage. ```json { "meldingen": { "fout": [ { "code": "IPD1999", "omschrijving": "De volgende opgegeven parameter(s) is (zijn) ongeldig: [lijst, van, ongeldige, queryParameters]" } ] } } ``` -------------------------------- ### KVK Zoeken API - Output Standard Source: https://developers.kvk.nl/documentation/index Details the standard JSON output format of the KVK APIs, including metadata and specific field formats like 'Registratiedatum' and 'Geo-data'. ```APIDOC ## Output Standard ### Description The KVK APIs use a standard JSON object for output, including metadata fields such as 'page', 'count', 'total', 'next', and 'previous'. ### Registratiedatum Format The 'Registratiedatum' (registration date) can contain zeros for unknown parts of the date. The format is YYYYMMDD. Examples: - Complete date: 20150622 - Day unknown: 20150600 - Month unknown: 20150000 - Date unknown: 00000000 ### Geo-data Parameter To retrieve geographic data, include the parameter `?geoData=true`. By default, this is set to `false`. Coordinates are provided if known. #### Example Geo-data in Address ```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 } } ] } ``` ``` -------------------------------- ### KVK Handelsregister Basisprofiel API Source: https://developers.kvk.nl/documentation/testing Retrieves detailed company profiles based on a KVK number. It offers sub-resources for owner, main branch, and branches. ```APIDOC ## GET /api/v1/basisprofielen/{KVKnummer} ### Description Retrieves the basic profile of a company using its KVK number. ### Method GET ### Endpoint https://api.kvk.nl/test/api/v1/basisprofielen/ ### Parameters #### Path Parameters - **KVKnummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "GET https://api.kvk.nl/test/api/v1/basisprofielen/90003942" } ``` ### Response #### Success Response (200) - **companyData** (object) - Contains the main company profile information. ### Sub-Resources #### GET /api/v1/basisprofielen/{KVKnummer}/eigenaar Retrieves owner information for the company. #### GET /api/v1/basisprofielen/{KVKnummer}/hoofdvestiging Retrieves abbreviated data for the main branch of the company. #### GET /api/v1/basisprofielen/{KVKnummer}/vestigingen Retrieves a list of branches associated with the company. ``` -------------------------------- ### KVK Handelsregister Zoeken API Source: https://developers.kvk.nl/documentation/testing Allows you to search for companies in the KVK Business Register by providing various search parameters. ```APIDOC ## GET /api/v2/zoeken ### Description Searches for companies in the KVK Business Register. ### Method GET ### Endpoint https://api.kvk.nl/test/api/v2/zoeken ### Parameters #### Query Parameters - **naam** (string) - Optional - The name of the company to search for. - **type** (string) - Optional - The type of establishment (e.g., 'hoofdvestiging', 'nevenvestiging'). - **plaats** (string) - Optional - The city to filter results by. - **straatnaam** (string) - Optional - The street name to filter results by. - **resultatenPerPagina** (integer) - Optional - Number of results per page. - **pagina** (integer) - Optional - The page number for pagination. ### Request Example ```json { "example": "GET https://api.kvk.nl/test/api/v2/zoeken?naam=test&type=hoofdvestiging&plaats=Veendam&straatnaam=Rietdekkershof" } ``` ### Response #### Success Response (200) - **data** (object) - Contains the search results. - **pagination** (object) - Contains pagination information. ``` -------------------------------- ### Zoeken API Source: https://developers.kvk.nl/documentation/zoeken-api The Zoeken API allows you to retrieve the KVK number of a registration. You can then request additional data using one of the other APIs. ```APIDOC ## GET /api/v2/zoeken ### Description Retrieves the KVK number of a registration. ### Method GET ### Endpoint https://api.kvk.nl/api/v2/zoeken ### Parameters #### Query Parameters (No specific query parameters are detailed in the provided text.) ### Request Example (No request example is provided in the text.) ### Response #### Success Response (200) - **Metadata** (object) - Contains metadata about the search results. - **Results** (array) - An array of registration results. - Each result object may contain: - **Binnenlands adres** (object) - Domestic address details. - **Buitenlands adres** (object) - Foreign address details. #### Response Example (No response example is provided in the text.) ``` -------------------------------- ### KVK Handelsregister Naamgeving API Source: https://developers.kvk.nl/documentation/testing Requests name data for companies from the KVK Business Register based on their KVK number. ```APIDOC ## GET /api/v1/naamgevingen/kvknummer/{KVKnummer} ### Description Retrieves name data for a company using its KVK number. ### Method GET ### Endpoint https://api.kvk.nl/test/api/v1/naamgevingen/kvknummer/ ### Parameters #### Path Parameters - **KVKnummer** (string) - Required - The KVK number of the company. ### Request Example ```json { "example": "GET https://api.kvk.nl/test/api/v1/naamgevingen/kvknummer/24330087" } ``` ### Response #### Success Response (200) - **nameData** (object) - Contains the name data associated with the KVK number. ``` -------------------------------- ### KVK Zoeken API - Status Codes and Legal Forms Source: https://developers.kvk.nl/documentation/index Details the standard HTTP status codes used for error handling and provides information on where to find lists of legal entities and country codes. ```APIDOC ## Status Codes ### Description Standard HTTP status codes and messages are used for error handling. ### Non-Exhaustive List of Error Codes - 400 - Bad request - 401 - Not authenticated - 404 - Not found - 500 - Internal server error ## Legal Entities Output ### Description Information on legal forms can be found in a provided PDF, which is in Dutch. It contains an extensive list of output legal forms. ### Foreign Legal Forms ### Description This PDF contains values for the 'omschrijvingRechtsvorm' attribute, specifically for foreign legal forms. The information is in Dutch. ### Country Codes ### Description A PDF detailing country codes is available, following the BRP country table (Table 34). The information is in Dutch. ``` -------------------------------- ### KVK Handelsregister Vestigingsprofiel API Source: https://developers.kvk.nl/documentation/testing Retrieves a profile for a specific location (branch) based on its location number. ```APIDOC ## GET /api/v1/vestigingsprofielen/{vestigingsnummer} ### Description Retrieves the profile for a specific business location using its location number. ### Method GET ### Endpoint https://api.kvk.nl/test/api/v1/vestigingsprofielen/ ### Parameters #### Path Parameters - **vestigingsnummer** (string) - Required - The location number of the branch. ### Request Example ```json { "example": "GET https://api.kvk.nl/test/api/v1/vestigingsprofielen/990000246530" } ``` ### Response #### Success Response (200) - **branchProfile** (object) - Contains the profile information for the specified location. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.