Inleiding
Onze JSON REST-API is makkelijk te integreren en bevat een logische opbouw van de methodes.
Een API is een set aan definities waarmee softwareprogramma's onderling kunnen communiceren. Het dient als een interface tussen verschillende softwareapplicaties waardoor de gebruikte code automatisch elkaar toegang tot informatie en/of functionaliteit geeft, zonder dat ontwikkelaars hoeven te weten hoe het andere programma exact werkt. REST staat voor Representational State Transfer. Het is een manier om webservices te creëren op basis van de bestaande en eenvoudige bouwstenen van het internet. SOAP is vervangen door URL's voor adressering en de HTTP methodes (GET, POST, DELETE en PUT) voor het aanroepen van de service. Iedere programmeertaal die momenteel toepasbaar is om dynamisch met HTTP om te gaan geschikt is voor het gebruik van REST.Wat is een API?
Wat is REST?
Verzoeken
API-sleutel
Om de API te kunnen gebruiken hebt u een API-sleutel nodig. Standaard hebt u de beschikking over een development-sleutel, deze kunt u gebruiken om test-verzoeken te doen, zonder dat deze van uw productie-limiet af gaat.
Productie-sleutels kunt u in veelvoud aanmaken, dit kan handig zijn als u bijvoorbeeld hetzelfde abonement op verschillende websites wilt gebruiken. U kunt dan onderscheidt maken tussen het totaal aantal verzoeken tussen verschillende websites.
De development-sleutel treft u standaard aan op uw dashboard als u bent ingelogd. De productie-sleutels dient u zelf aan te maken, dit kunt u tevens doen op uw dashboard.
Autoriseren
Het verzoek autoriseren doet u doormiddel van een basic access authentication-verzoek. U dient uw gebruikersnaam (e-mailadres) en API-sleutel mee te sturen in de Authorization
-header als Basic
verzoek.
Verzoek
curl -X GET \ -H "Content-Type: application/json" \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/authorization/me.json
Antwoord (headers)
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 X-API-Version: 1.0 X-Parse-Time: 0.0315
Antwoord
{ "success": 1, "data": { "customer": { "username": "user@company.com", "planDescription": "Small", "dateCreated": "2017-03-31 13:51:28" }, "accessToken": { "isDevelopment": false, "description": null, "dateCreated": "2017-03-31 13:52:45", "dateExpiration": null } } }
API versie
Momenteel wordt alleen versie 1.0 van de API ondersteund, bij uitbreidingen in de toekomst is het wellicht mogelijk een extra parameter mee te geven om de API-versie te bepalen.
Taal
Sommige velden hebben een taalafhankelijke omschrijving, de vertaling die wordt teruggegeven is afhankelijk van de Accept-Language
-header. Taalafhankelijke velden herkent u aan de oranje code tekst
, deze waarden kunnen dus variëren indien u een andere taal meestuurd.
De talen die momenteel worden ondersteund zijn Nederlands en Frans en in mindere maten Engels. Indien er geen vertaling is voor het veld in de taal die wordt aangevraagd, wordt de standaard taal Nederlands gebruikt.
Aan de hand van de Content-Language
-header in het antwoord, kunt u de taal vinden die wordt teruggegeven.
Voorbeeld (Nederlands)
Verzoek
curl -X GET \ -H "Accept-Language: nl" \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/activity/get-list.json?entityNumber=0123456789
Antwoord (headers)
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Language: nl X-API-Version: 1.0 X-Parse-Time: 0.0315
Antwoord
{ "success": 1, "count": 1, "data": [ { "activityGroup": "BTW001", "activityGroupDescription": "BTW-activiteiten", "naceVersion": 2003, "naceCode": "41000", "naceDescription": "Winning, zuivering en distributie van water", "classification": "MAIN", "classificationDescription": "Hoofdactiviteit" } } }
Voorbeeld (Frans)
Verzoek
curl -X GET \ -H "Accept-Language: fr" \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/activity/get-list.json?entityNumber=0123456789
Antwoord (headers)
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Language: fr X-API-Version: 1.0 X-Parse-Time: 0.0315
Antwoord
{ "success": 1, "count": 1, "data": [ { "activityGroup": "BTW001", "activityGroupDescription": "Activités TVA", "naceVersion": 2003, "naceCode": "41000", "naceDescription": "Captage, épuration et distribution d'eau", "classification": "MAIN", "classificationDescription": "Activité principale" } } }
Paginering
Sommige methoden geven meer dan één resultaat terug, het maximaal aantal resultaten per verzoek is afhankelijk van het door u afgenomen abonnement.
Antwoord
Methoden die pagineerbaar zijn geven altijd de pagination
-waarde terug, deze bevat de volgende waarden:
-
pagination[limit]
Het toegepaste limiet op de resultaten -
pagination[page]
De huidige pagina -
pagination[totalPages]
Het totaal aantal pagina's -
pagination[totalItems]
Het totaal aantal resultaten -
pagination[countItems]
Het aantal resultaten in het antwoord
Headers
In de response-headers van het verzoek worden een aantal API-afhankelijke headers meegestuurd. Sommige kunnen handig zijn om bijvoorbeeld te bepalen hoeveel verzoeken u resterend heeft voor de huidige periode en wat een type sleutel u gebruikt.
Voorbeeld (headers)
Antwoord
X-API-Version: 1.0 X-API-Key-Type: development X-API-Request-Count: 123 X-API-Request-Limit: 500 X-API-Search-Request-Count: 89 X-API-Search-Request-Limit: 200
Beschrijving
Onderstaande headers worden teruggegeven in een verzoek. Sommige waarden kunnen afhankelijk zijn van het type sleutel dat wordt gebruikt (ontwikkelings- of productiesleutel).
-
X-API-Version
De gebruikt API-versie, op dit moment alleen versie1.0
. -
X-API-Key-Type
Geeft het type sleutel,development
geeft aan dat een ontwikkelingssleutel wordt gebruikt enproduction
betreft een productiesleutel. -
X-API-Request-Count
Het huidig aantal gebruikte limiet, dit is exclusief het huidige verzoek. -
X-API-Request-Limit
Het maximale limiet van het abonnement. -
X-API-Search-Request-Count
Het huidig aantal gebruikte zoek-limiet, dit is exclusief het eventuele huidige verzoek. -
X-API-Search-Request-Limit
Het maximale zoek-limit van het abonnement.
Deze gegevens dienen als hulpmiddel en zijn tevens visueel terug te zien op uw dashboard.
Methoden
Alle methoden dienen te beginnen met https://api.kbodata.app/v1/
.
Parameters met een (asterisk) als voorvoegsel zijn verplicht, zonder deze parameters zal het verzoek mislukken. Overige parameters zijn optioneel.
Om geen bedrijfsgegevens op onze website te publiceren, maken wij gebruik fictieve handelsnamen en ondernemingsnummers in onze voorbeelden.
Voordat u begint is het handig om een duidelijk beeld te hebben van de data structuur, hieronder treft u een afbeelding van de soorten data met hierbij een hierargie van data die aan elkaar gerelateerd zijn.

Zoals u kunt zien kan een handelsnaam
, adres
en activiteit
zowel aan een onderneming
als een vestiging
gekoppeld zijn. Helaas zijn hiervoor geen vaste regels. Het kan dus zijn dat de onderneming geen adressen bevat, maar de vestiging wel, maar andersom is ook goed mogelijk. Het is dus altijd verstanding om ook de vestigingen van de ondernemingen te controleren als u opzoek bent naar specifieke data.
Ondernemingen
GET
/enterprise/get.json
Verkrijg de onderneminggegevens doormiddel van het ondernemingsnummer.
Parameters
-
enterpriseNumber
Het ondernemingsnummer van de inschrijving.
Antwoord
-
enterpriseNumber
Het ondernemingsnummer zonder leestekens -
enterpriseNumberFormatted
Het ondernemingsnummer gescheiden doormiddel van punten -
status
Inschijfstatus van de onderneming, vrijwel altijd1
-
type
Code met betrekking tot de type inschrijving. 0: Onbekend, 1: Natuurlijk persoon, 2: Rechtspersoon -
typeDescription
Omschrijving van het inschrijvingstype -
juridicalSituationCode
Code juridische situatie -
juridicalSituationDescription
Omschrijving van de juridische situatie -
juridicalFormCode
Juridische vorm code -
juridicalFormDescription
Omschrijving van de juridische vorm -
dateStart
Inschrijfdatum van de onderneming -
vatNumber
Het BTW-nummer van de onderneming
Controleer altijd het BTW-nummer voor grensoverschrijdende transacties. -
addresses
De addressen die zijn gekoppeld aan de ondernemingsinschrijving. Voor de specifieke velden kunt u de adressen-sectie raadplegen. -
establishments
De vestigingen die zijn gekoppeld aan de ondernemingsinschrijving. Voor de specifieke velden kunt u de vestigingen-sectie raadplegen. -
denominations
De handelsnamen die zijn gekoppeld aan de ondernemingsinschrijving. Voor de specifieke velden kunt u de handelsnamen-sectie raadplegen.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/enterprise/get.json?enterpriseNumber=0123456789
Antwoord
{ "success": 1, "data": { "enterpriseNumber": "0123456789", "enterpriseNumberFormatted": "0123.456.789", "status": "1", "type": 2, "juridicalSituationCode": "000", "juridicalSituationDescription": "Normale toestand", "juridicalFormCode": "411", "juridicalFormDescription": "Stad \/ gemeente", "dateStart": "2000-01-01", "vatNumber": "BE0123456789", "addresses": [ { "type": "REGO", "typeDescription": "Maatschappelijke zetel", "zipcode": "6581", "cityNL": "Malden", "cityFR": "Malden", "streetNL": "De Steiger", "streetFR": "De Steiger", "addressNumber": "23", "addressAdditional": null, "dateRevoke": "2017-01-01" } ], "establishments": [ { "establishmentNumber": "2123456789", "establishmentNumberFormatted": "2.123.456.789", "dateStart": "2017-01-1" } ], "denominations": [ { "value": "KBO Databank", "language": "NL", "type": 1, "typeDescription": "Maatschappelijke naam" }, { "value": "KBO Base de données", "language": "FR", "type": 1, "typeDescription": "Maatschappelijke naam" } ] } }
BTW-nummer
GET
/vat-number/verify.json
Controleer voor een geldig BTW-nummer voor grensoverschrijdende transactie binnen de Europese Unie (VIES).
Zelfs wanneer deze methode false
teruggeeft, kan het zijn dat het BTW-nummer nog steeds geldig is voor binnenlandse (België) transacties.
(dit eindpunt kan alleen worden gebruikt met een productiesleutel, het verzoek zal falen met een ontwikkelingssleutel)
Parameters
-
enterpriseNumber
Het vestigingsnummer van de inschrijving.
(deze parameter is niet verplicht als de parametervatNumber
wordt gebruikt) -
vatNumber
Een Belgisch BTW-nummer, beginnend met BE, gevolgd door 10 cijfers.BE0123456789
(deze parameter is niet verplicht als de parameterenterpriseNumber
wordt gebruikt)
Antwoord
-
isValid
true
bij een geldig BTW-nummer;
false
bij een ongeldig BTW-nummer of ongeldig voor grensoverschrijdende transacties. -
vatNumber
Het geverifieerde BTW-nummer -
details
Registratiegegevens van het BTW-nummer zoals bekend bij de Europese Unie.
(alleen bij een geldig BTW-nummer) -
enterpriseNumber
Het ondernemingsnummer van de gecontroleerde onderneming.
(alleen bij gebruik van deenterpriseNumber
parameter) -
enterpriseNumberFormatted
Het ondernemingsnummer van de gecontroleerde onderneming, gescheiden door punten.
(alleen bij gebruik van deenterpriseNumber
parameter)
Voorbeeld enterpriseNumber
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/vat-number/verify.json?enterpriseNumber=0123456789
Antwoord
{ "success": 1, "data": { "isValid": true, "vatNumber": "BE0123456789", "details": { "name": "FaimMedia B.V.", "address": "Steiger 00023, 6581KZ MALDEN" }, "enterpriseNumber": "0123456789", "enterpriseNumberFormatted": "0123.456.789" } }
Voorbeeld vatNumber
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/vat-number/verify.json?vatNumber=BE0123456789
Antwoord
{ "success": 1, "data": { "isValid": true, "vatNumber": "BE0123456789", "details": { "name": "FaimMedia B.V.", "address": "Steiger 00023, 6581KZ MALDEN" } } }
Vestigingen
GET
/establishment/get.json
Verkrijg de vestigingensgegevens doormiddel van het vestigingsnummer.
Parameters
-
establishmentNumber
Het vestigingsnummer van de inschrijving.
Antwoord
-
enterpriseNumber
Het ondernemingsnummer zonder leestekens, dat bij deze vestigingsinschrijving hoort -
enterpriseNumberFormatted
Het ondernemingsnummer gescheiden doormiddel van punten, dat bij deze vestigingsinschrijving hoort -
establishmentNumber
Het vestigingsnummer zonder leestekens -
establishmentNumberFormatted
Het vestigingsnummer gescheiden doormiddel van punten -
dateStart
Inschrijfdatum van de vestiging -
addresses
De addressen die zijn gekoppeld aan deze vestigingsinschrijving. Voor de specifieke velden kunt u de adressen-sectie raadplegen. -
denominations
De handelsnamen die zijn gekoppeld deze vestigingsinschrijving. Voor de specifieke velden kunt u de handelsnamen-sectie raadplegen.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/establishment/get.json?establishmentNumber=0123456789
Antwoord
{ "success": 1, "data": { "enterpriseNumber": "0123456789", "enterpriseNumberFormatted": "0123.456.789", "establishmentNumber": "2123456789", "establishmentNumberFormatted": "2.123.456.789", "dateStart": "2017-01-01", "addresses": [ { "type": "BAET", "typeDescription": "Vestigingseenheid", "zipcode": "6581", "cityNL": "Malden", "cityFR": "Malden", "streetNL": "De Steiger", "streetFR": "De Steiger", "addressNumber": "23", "addressAdditional": null, "dateRevoke": "2017-01-01" } ], "denominations": [ { "value": "KBO Databank", "language": "NL", "type": 1, "typeDescription": "Maatschappelijke naam" }, { "value": "KBO Base de données", "language": "FR", "type": 1, "typeDescription": "Maatschappelijke naam" } ] } }
Handelsnamen
GET
/denomination/search.json
Zoek naar handelsnamen doormiddel van zoektermen of een inschrijvingsnummer.
Zowel ondernemingen als vestigingen kunnen één of meerdere handelsnamen hebben. Hoewel een onderneming vrijwel altijd minimaal één handelsnaam heeft, kan hier niet vanuit worden gegaan. Het is dus verstandig om alsnog de handelsnamen van de vestigingen die bij de onderneming horen te raadplegen.
Parameters
-
query
De zoekterm om te zoeken naar de handelsnaam.
(deze parameter is niet verplicht als de parameterentityNumber
wordt gebruikt) -
entityNumber
Het ondernemingsnummer of vestigingsnummer van de inschrijving.
(deze parameter is niet verplicht als de parameterquery
wordt gebruikt) -
filter[entityType]
Geaccepteerde waarden:enterprise
: toon alleen ondernemingen,establishment
: toon alleen vestigingen -
filter[type]
Filter op het type handelsnaam. U vindt de geaccepteerde waarden onder in de antwoord-sectie.
Antwoord
-
entityNumber
Het inschrijfnummer zonder leestekens, dat bij deze vestigingsinschrijving hoort. -
entityNumberFormatted
Het inschrijfnummer gescheiden doormiddel van punten, dat bij deze vestigingsinschrijving hoort -
entityType
Het type handelsnaam, in het geval van een onderneming is ditenterprise
, in het geval van een vestiging is ditestablishment
. -
enterpriseNumber
Het ondernemingsnummer zonder leestekens, dat bij deze vestigingsinschrijving hoort. -
enterpriseNumberFormatted
Het ondernemingsnummer gescheiden doormiddel van punten, dat bij deze vestigingsinschrijving hoort. -
value
De handelsnaam van de inschrijving -
language
De taal van de desbetreffende handelsnaam -
type
Type handelsnaam nummer, kan een van de volgende waarde bevatten:0
Onbekend1
Maatschappelijke handelsnaam2
Afkorting3
Commerciele handelsnaam
-
typeDescription
Type handelsnaam omschrijving -
description
verouderdHetzelfde alstypeDescription
, is verouderd en dient niet meer gebruikt te worden.
Dit veld wordt alleen weergegeven indien de handelsnaam bij een vestiging hoort, bij een handelsnaam van een onderneming bevatten de velden entityNumber
en entityNumberFormatted
reeds het ondernemingsnummer.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/denomination/search.json?query=databank
Antwoord
{ "success": 1, "count": 4, "pagination" : { }, "data": [ { "entityNumber": "0436969360", "entityNumberFormatted": "0436.969.360", "entityType": "enterprise", "value": "DE BRUGSE DATABANK", "language": "NL", "type": 1, "typeDescription": "Maatschappelijke naam", "description": "Maatschappelijke naam" }, { "entityNumber": "0442157870", "entityNumberFormatted": "0442.157.870", "entityType": "enterprise", "value": "INVESTMENTS OVERSEAS DATABANK EUROGOLD", "language": "FR", "type": 1, "typeDescription": "Maatschappelijke naam", "description": "Maatschappelijke naam" }, { "entityNumber": "0443786678", "entityNumberFormatted": "0443.786.678", "entityType": "enterprise", "value": "WEST VLAAMSE DATABANK", "language": "NL", "type": 1, "typeDescription": "Maatschappelijke naam", "description": "Maatschappelijke naam" }, { "entityNumber": "0446386476", "entityNumberFormatted": "0446.386.476", "entityType": "enterprise", "value": "Omni Databank", "language": "NL", "type": 1, "typeDescription": "Maatschappelijke naam", "description": "Maatschappelijke naam" } } }
Adres
GET
/address/get.json
Verkrijg het adres van onderneming of vestiging doormiddel van het inschrijfnummer en type-code.
Parameters
-
entityNumber
Het ondernemingsnummer of vestigingsnummer van de inschrijving. -
type
Het type code van het inschrijfadres, mogelijke waarden:1
: Bijhuis2
: Vestigingseenheid3
: Oudste actieve vestigingseenheid4
: Maatschappelijke zetel
Antwoord
-
entityNumber
Het inschrijfnummer zonder leestekens, dat bij deze vestigingsinschrijving hoort. -
entityNumberFormatted
Het inschrijfnummer gescheiden doormiddel van punten, dat bij deze vestigingsinschrijving hoort -
entityType
Het type handelsnaam, in het geval van een onderneming is ditenterprise
, in het geval van een vestiging is ditestablishment
. -
type
De type code van het inschrijfadres, mogelijke waarden:0
: Onbekend1
: Bijhuis2
: Vestigingseenheid3
: Oudste actieve vestigingseenheid4
: Maatschappelijke zetel
-
typeDescription
De type omschrijving die bij de type code hoort. -
zipcode
Postcode van de inschrijving -
cityNL
De Nederlandse vertaling van de plaatsnaam -
cityFR
De Franse vertaling van de plaatsnaam -
streetNL
De Nederlands vertaling van de straatnaam -
streetFR
De Franse vertaling van de straatnaam -
addressNumber
Het huisnummer van de inschrijving -
addressAdditional
Eventuele extra adrestoevoeging -
dateRevoke
Uitschrijfdatum van het adres, kan zowel in de toekomst als in het verleden zijn.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/address/get-list.json?entityNumber=0123456789&type=4
Antwoord
{ "success": 1, "data": { "entityNumber": "0400377891", "entityNumberFormatted": "0400.377.891", "entityType": "enterprise", "type": 4, "typeDescription": "Maatschappelijke zetel", "zipcode": null, "cityNL": "Brierley Hill, Staffs", "cityFR": "Brierley Hill, Staffs", "streetNL": "P.O. Box 20 Leuches Bridge", "streetFR": "P.O. Box 20 Leuches Bridge", "addressNumber": null, "addressAdditional": null, "dateRevoke": "2017-03-31" } }
Adressen per entiteit
GET
/address/get-list.json
Verkrijg alle adressen van een onderneming of vestiging doormiddel van het inschrijfnummer.
Parameters
-
entityNumber
Het ondernemingsnummer of vestigingsnummer van de inschrijving.
Antwoord
De antwoord waarden zijn hetzelfde als het get.json-verzoek.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/address/get-list.json?entityNumber=0123456789
Antwoord
{ "success": 1, "data": [ { "entityNumber": "0400377891", "entityNumberFormatted": "0400.377.891", "entityType": "enterprise", "type": 4, "typeDescription": "Maatschappelijke zetel", "zipcode": null, "cityNL": "Brierley Hill, Staffs", "cityFR": "Brierley Hill, Staffs", "streetNL": "P.O. Box 20 Leuches Bridge", "streetFR": "P.O. Box 20 Leuches Bridge", "addressNumber": null, "addressAdditional": null, "dateRevoke": "2017-03-31" } ] }
Adressen zoeken
GET
/address/search.json
Verkrijg alle adressen met een bepaalde zoekwaarde.
Parameters
-
query
De zoekwaarde, deze dient uit minimaal drie tekens te bestaan. -
fields
(array)Een reeks (array) van zoekvelden, mogelijk waarden zijn:street
,zipcode
,city
. Indien deze parameter wordt weggelaten, wordt op alle velden gezocht. -
type
Het type code van het inschrijfadres, mogelijke waarden:1
: Bijhuis2
: Vestigingseenheid3
: Oudste actieve vestigingseenheid4
: Maatschappelijke zetel
Antwoord
De antwoord waarden zijn hetzelfde als het get.json-verzoek.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/address/search.json?query=Kerk&fields[]=street&fields[]=city&type=4
Antwoord
{ "success": 1, "data": [ { "entityNumber": "0400377891", "entityNumberFormatted": "0400.377.891", "entityType": "enterprise", "type": 4, "typeDescription": "Maatschappelijke zetel", "zipcode": null, "cityNL": "Brierley Hill, Staffs", "cityFR": "Brierley Hill, Staffs", "streetNL": "P.O. Box 20 Leuches Bridge", "streetFR": "P.O. Box 20 Leuches Bridge", "addressNumber": null, "addressAdditional": null, "dateRevoke": "2017-03-31" } ] }
Activiteiten
GET
/activity/get-list.json
Verkrijg alle activiteiten van een onderneming of vestiging.
Parameters
-
entityNumber
Het ondernemingsnummer of vestigingsnummer van de inschrijving. -
filter[naceVersion]
Filter op het veldnaceVersion
-
filter[naceCode]
Filter op het veldnaceCode
-
filter[activityGroup]
Filter op het veldactivityGroup
-
filter[classification]
Filter op het veldclassification
Antwoord
-
activityGroup
Activiteitengroep -
activityGroupDescription
Omschrijving van de activiteiten groep -
naceVersion
Nace versie -
naceCode
Nace code -
naceDescription
Nace omschrijving -
classification
Classificatie code -
classificationDescription
Classificatie omschrijving
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/activity/get-list.json?entityNumber=0123456789
Antwoord
{ "success": 1, "count": 4, "data": [ { "activityGroup": "BTW001", "activityGroupDescription": "BTW-activiteiten", "naceVersion": 2003, "naceCode": "41000", "naceDescription": "Winning, zuivering en distributie van water", "classification": "MAIN", "classificationDescription": "Hoofdactiviteit" }, { "activityGroup": "BTW001", "activityGroupDescription": "BTW-activiteiten", "naceVersion": 2008, "naceCode": "84114", "naceDescription": "Gemeentelijke overheid, met uitzondering van het O.C.M.W.", "classification": "MAIN", "classificationDescription": "Hoofdactiviteit" }, { "activityGroup": "BTW001", "activityGroupDescription": "BTW-activiteiten", "naceVersion": 2008, "naceCode": "56309", "naceDescription": "Andere drinkgelegenheden", "classification": "SECO", "classificationDescription": "Nevenactiviteit" }, { "activityGroup": "PPO001", "activityGroupDescription": "RSZPPO-activiteiten", "naceVersion": 2008, "naceCode": "84114", "naceDescription": "Gemeentelijke overheid, met uitzondering van het O.C.M.W.", "classification": "MAIN", "classificationDescription": "Hoofdactiviteit" } ] }
Authorisatie
GET
/authorization/me.json
Hiermee krijgt u informatie over de huidige gebruikte API-sleutel en de gebruiker die hier aangekoppeld is.
Voorbeeld
Verzoek
curl -X GET \ -u user@company.com:tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7 \ https://api.kbodata.app/v1/authorization/me.json
Antwoord
{ "success": 1, "data": { "customer": { "username": "user@company.com", "planDescription": "Large", "dateCreated": "2017-03-31 13:51:28" }, "accessToken": { "isDevelopment": false, "description": "Website production key", "dateCreated": "2017-03-31 13:52:45", "dateExpiration": "2018-03-31" } } }
Antwoorden
HTTP status codes
Bij het antwoord van uw verzoek wordt meegestuurd of het antwoord succesvol is. Dit wordt gedaan middels de HTTP-statuscode. Indien een verzoek niet succesvol is, kunt u meestal aan de hand van de HTTP-status en de fout in het JSON-antwoord achterhalen wat er misging en eventueel aangepast dient te worden in het verzoek. Hieronder treft u een lijst met veel voorkomende HTTP-status codes die gebruikt worden in onze API.
Tevens wordt er een extra success
parameter meegestuurd in het antwoord, deze is 1
(cijfer één) bij een succesvol verzoek en 0
(cijfer nul) bij een fouttief verzoek. Hieruit is echter niet te herleiden om wat voor een type fout het gaat.
-
200 OK
Succesvol Het verzoek was succesvol en de data kan gebruikt worden. -
401 Unauthorized
Niet geautoriseerd Deze status code krijgt u meestal terug als de authorisatie niet geldig is, dit kan te maken hebben met een niet geldige gebruikersnaam of API-sleutel. -
402 Payment Required
Betaling nodig Houdt in dat uw abonnement is verlopen en deze dient te worden verlengd. Dit kunt u doen als u bent ingelogd in uw account. -
404 Not Found
Niet gevonden Wordt als antwoord gegeven als het specifiek opgevraagde item niet kan worden gevonden. Wordt tevens gebruikt bij een methode die niet bestaat, maar de API-sleutel wel geldig is. -
405 Method Not Allowed
Methode niet toegestaan De gebruikte methode wordt niet geaccepteerd, dit komt bijvoorbeeld voor indien het verzoek wordt aangevraagd alsPOST
, maar deze dient eenGET
te zijn. -
409 Conflict
Conflict Het aangevraagde verzoek kon niet worden verwerkt, meestal door parameters die verplicht zijn, maar niet in het verzoek aanwezig zijn of parameters die een onjuist formaat bevatten. -
429 Too Many Requests
Te veel requests U hebt het maximaal aantal verzoeken voor deze maand overschreven, wacht tot het einde van uw periode totdat het limiet gereset word of upgrade uw abbonement. Dit kunt u doen in uw dashboard.