Intro
Our JSON REST-API is easy to integrate and contains a logical structure of the methods.
An Application Programming Interface (API) is a computing interface which defines interactions between multiple software intermediaries.
It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, without developers having to know how the other software exactly works.
Representational State Transfer (for short REST) is a software architectural style that defines a set of constraints to be used for creating Web services. SOAP has been replaced with URLs for addressing and the HTTP methods (GET, POST, DELETE and PUT) for calling the service. Any programming language currently applicable to dynamically handle HTTP requests, in example with a cURL-library, is suitable for using REST.What's an API?
What's an REST API?
Requests
API-token
To make requests to the API-endpoints, you will need an API-token. For development purposes, you can use a development-token. With this you can do test-requests, which will return a number of fixed results, and will not use your production-limit. Never use a development-token in a production environment.
You may create multiple production token, this can be useful if you would like to use the same subscription on different websites. You can make distinction between multiple websites or apps and the total number of requests.
You may create API-tokens for both development- and production requests on your dashboard.
Authorization
You authorize the request by using a Bearer
-token (your API-key) in the Authorization
-header.
200
Success response
curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/me
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.02506 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Customer": { "username": "user@company.com", "planDescription": "Unlimited", "dateCreated": "2017-05-22 09:22:38" }, "ApiAccessToken": { "isDevelopment": false, "description": "API Docs", "dateCreated": "2020-09-05 22:49:12", "dateExpiration": null } }
Pagination
Some methods return more than one result and are paginated over multiple pages.
These requests will always include a Pagination
-object.
The maximum number of results per request depend on the purchased plan.
Response
-
FieldTypeDescription
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your plan -
page
integer
The current page -
totalPages
integer
The number of pages -
totalItems
integer
The total number of items in the source data -
countItems
integer
The number of items in the current request
Headers
A number of API-related headers are included in the response headers of the request. They are useful to determine how many requests you have left for the current period and what type of key you're currently using.
The headers below are displayed in a request. Some values may depend on the type of key used (development- or production key). This details serves as an aid, and can also be seen visually on your dashboard.Exemple (headers)
X-API-Key-Type: production
X-API-Request-Count: 124
X-API-Request-Limit: 1000
X-API-Search-Request-Count: 794
X-API-Search-Request-Limit: 1000
Description
X-API-Key-Type
string
X-API-Request-Count
integer
X-API-Request-Limit
integer
X-API-Search-Request-Count
integer
X-API-Search-Request-Limit
integer
Endpoints
All end-points must begin with one of the following protocol and domain name, depending on the implementation and key-type:
-
Protocol and domain nameTypeDescription
-
https://api.kbodata.app/v2/
KBO API (production key)https://mock.api.kbodata.app/v2/
KBO Mock API (development key)Arguments prefixed with a (asterisk) are required, without these arguments the request will fail. Other arguments are optional.
To not publish any (old or incorrect) enterprise data on our website, we use fictional data in our examples.
Before you start with the implementation of our API, it is useful to have a clear picture of the data structure, below you fill find an image of the hierarchy of data and how they relate to each other.
As you can see, a
denomination
,address
andactivity
can be related to both an enterprise or an establishment. Unfortunately, there are not any fixed rules for this structure. So in example it will be possible that an enterprise does not have any registration addresses, however the establishment linked to the enterprise does. Vice versa is also possible. Therefore, it is always a good idea to check the establishments of the enterprises if you are looking for any specific data.Endpoints overview
Enterprises
-
Retrieve enterprise details.
/enterprise/{enterpriseNumber} -
Retrieve all enterprise activities.
/enterprise/{enterpriseNumber}/activities -
Retrieve all enterprise addresses.
/enterprise/{enterpriseNumber}/addresses -
Retrieve a specific enterprise address by type.
/enterprise/{enterpriseNumber}/address/{type} -
Retrieve contact information of the enterprise.
/enterprise/{enterpriseNumber}/contact -
Retrieve all enterprise denominations.
/enterprise/{enterpriseNumber}/denominations -
Retrieve a specific enterprise denomination.
/enterprise/{enterpriseNumber}/denomination/{language}/{type} -
Retrieve all enterprise establishments.
/enterprise/{enterpriseNumber}/establishments -
Retrieve short financial information of the enterprise.
/enterprise/{enterpriseNumber}/financial -
Retrieve all official functions of the enterprise.
/enterprise/{enterpriseNumber}/roles Establishments
-
Retrieve establishment details.
/establishment/{establishmentNumber} -
Retrieve all establishment activities.
/establishment/{establishmentNumber}/activities -
Retrieve the address of the establishment address.
/establishment/{establishmentNumber}/address -
Retrieve contact information of the establishment.
/establishment/{establishmentNumber}/contact -
Retrieve all establishment denominations.
/establishment/{establishmentNumber}/denominations -
Retrieve a specific establishment denomination.
/establishment/{establishmentNumber}/denomination/{language}/{type} Denominations
-
Autocomplete trade names (denominations)
/denominations Addresses
-
Search for multiple addresses.
/addresses Nace
-
Search for nace code
/naces -
Get NACE by version and code
/nace/{naceVersion}/{naceCode} Roles
-
Search for a role code (function title)
/roles -
Get a specific function title by code
/role/{roleCode} Juridical
-
Search for a juridical form
/juridical-forms -
Search for a juridical situation
/juridical-situations VAT
-
Verify VAT-number or enterprise number for internation transactions within the EU
/vat/{vatNumber} Customer
-
Get authorized customer information
/me
/enterprise/{enterpriseNumber}Retrieve enterprise details.Retrieve the enterprise details by the enterprise number.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | Enterprise is found.
-
FieldTypeDescription
-
Enterprise
object
-
enterpriseNumber
string
The enterprise number as digits only.Example:0417497106
-
enterpriseNumberFormatted
string
The enterprise number as formatted human readable string.Example:0417.497.106
-
vatNumber
string
VAT numberExample:BE0417497106
-
status
integer
Active (1
) of Inactive (2
) companyExample:1
-
type
string
The company type,natural
for natural person orentity
for legal entity.Possible values:natural
entity
Example:entity
-
typeDescription
object
-
nl
string
Dutch descriptionExample:Rechtspersoon
-
en
string
English descriptionExample:Legal entity
-
fr
string
French descriptionExample:Personne morale
-
de
string
German descriptionExample:Juristische Person
-
juridicalSituationCode
string
Juridical situation codeExample:000
-
juridicalSituationDescription
object
-
juridicalFormCode
string
This field is deprecated and will be removed in future versions, please use theJuridicalForm
object instead.Example:030
-
juridicalFormDescription
object
This field is deprecated and will be removed in future versions, please use theJuridicalForm
object instead. -
JuridicalForm
object
-
juridicalFormCode
string
Juridical Form codeExample:030
-
description
object
-
nl
string
Dutch description of the juridical formExample:Buitenlandse entiteit
-
fr
string
French description of the juridical formExample:Entité étrangère
-
de
string
German description of the juridical formExample:Ausländische Einheit
-
JuridicalSituation
object
-
juridicalSituationCode
string
Juridical Situation codeExample:000
-
description
object
-
nl
string
Dutch description of the juridical situationExample:Normale toestand
-
fr
string
French description of the juridical situationExample:Situation normale
-
de
string
German description of the juridical situationExample:Gewöhnlicher Zustand
-
dateStart
string
Example:2020-01-01
Exemple
200
Successful responseEnterprise is found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03355 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Enterprise": { "enterpriseNumber": "0417497106", "enterpriseNumberFormatted": "0417.497.106", "vatNumber": "BE0417497106", "status": 1, "type": "entity", "typeDescription": { "nl": "Rechtspersoon", "en": "Legal entity", "fr": "Personne morale", "de": "Juristische Person" }, "dateStart": "1977-08-02", "JuridicalSituation": { "juridicalSituationCode": "000", "description": { "nl": "Normale toestand", "fr": "Situation normale", "de": "gewöhnlicher Zustand" } }, "JuridicalForm": { "juridicalFormCode": "014", "description": { "nl": "Naamloze vennootschap", "fr": "Société anonyme", "de": "Aktiengesellschaft" } } } }
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/activitiesRetrieve all enterprise activities.Retrieve all registered activity details by the enterprise number.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | All activities from the enterprise.
-
FieldTypeDescription
-
[]
array
-
Activity
object
-
activityGroup
string
Possible values:BTW001
EDR001
OLK001
POR001
PPO001
RSZ001
SCO001
Example:BTW001
-
activityGroupDescription
object
-
nl
string
Dutch descriptionExample:BTW-activiteiten
-
fr
string
French descriptionExample:Activités TVA
-
en
string
English descriptionExample:VAT activities
-
de
string
German descriptionExample:MwSt.-Aktivitäten
-
classification
string
Possible values:ANCI
MAIN
SECO
Example:MAIN
-
classificationDescription
object
-
nl
string
Dutch descriptionExample:Hoofdactiviteit
-
fr
string
French descriptionExample:Activité principale
-
en
string
English descriptionExample:Main activity
-
de
string
German descriptionExample:Hauptaktivität
-
Nace
object
-
naceVersion
integer
Example:2008
-
naceCode
string
Example:474
-
description
object
-
nl
string
Dutch descriptionExample:Detailhandel in ICT-apparatuur in gespecialiseerde winkels
-
fr
string
French descriptionExample:Commerce de détail d'équipements de l'information et de la communication en magasin spécialisé
Exemple
200
Successful responseAll activities from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/activities
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03129 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Activity": { "activityGroup": "001", "activityGroupDescription": { "nl": "BTW-activiteiten", "en": "VAT activities", "fr": "Activités TVA", "de": "MwSt.-Aktivitäten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2003, "naceCode": "74151", "description": { "nl": "Managementactiviteiten van holdings", "fr": "Activités de gestion et d'administration de holdings" } } } }, { "Activity": { "activityGroup": "001", "activityGroupDescription": { "nl": "BTW-activiteiten", "en": "VAT activities", "fr": "Activités TVA", "de": "MwSt.-Aktivitäten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2008, "naceCode": "70100", "description": { "nl": "Activiteiten van hoofdkantoren", "fr": "Activités des sièges sociaux" } } } }, { "Activity": { "activityGroup": "006", "activityGroupDescription": { "nl": "RSZ-activiteiten", "en": "NOSS activities", "fr": "Activités ONSS", "de": "LSS-Tätigkeiten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2003, "naceCode": "74151", "description": { "nl": "Managementactiviteiten van holdings", "fr": "Activités de gestion et d'administration de holdings" } } } }, { "Activity": { "activityGroup": "006", "activityGroupDescription": { "nl": "RSZ-activiteiten", "en": "NOSS activities", "fr": "Activités ONSS", "de": "LSS-Tätigkeiten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2008, "naceCode": "70100", "description": { "nl": "Activiteiten van hoofdkantoren", "fr": "Activités des sièges sociaux" } } } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/addressesRetrieve all enterprise addresses.Retrieve all the addresses details by the enterprise number.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | All addresses from the enterprise.
-
FieldTypeDescription
-
[]
array
-
Address
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
type
string
The address type, possible values:branch
: Branch office
unit
: Establishment unit
*active-unit
: Active establishment unit
*legal-entity
: Head office
Possible values:branch
unit
active-unit
legal-entity
Example:branch
-
typeDescription
object
-
nl
string
Dutch descriptionExample:Maatschappelijke zetel
-
en
string
English descriptionExample:Head office
-
fr
string
French descriptionExample:Siège social
-
de
string
German descriptionExample:Sitzes Adresse
-
street
object
Street of the registration -
nl
string
Dutch street translation of the registrationExample:Kerkstraat
-
fr
string
French street translation of the registrationExample:Rue de l'Église
-
addressNumber
string
Address street number of the registrationExample:1
-
addressAdditional
string
Additional address or street suffixExample:Unit 12, Floor 5
-
postOfficeBox
string
The post office box of the address, if applicableExample:Box 5
-
zipcode
string
Zipcode of the registrationExample:2000
-
city
object
City of the registration -
nl
string
Dutch city translation of the registrationExample:Brussel
-
fr
string
French city translation of the registrationExample:Bruxelles
-
country
object
Country, is null if country is Belgium. -
nl
string
Dutch translation of the countryExample:Frankrijk
-
fr
string
French translation of the countryExample:France
-
dateRevoke
string
The revoke date of the address, could both be a date in the history or in the future.Example:2003-03-14
Exemple
200
Successful responseAll addresses from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/addresses
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03950 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Address": { "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grand-Place" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "1000", "city": { "nl": "Brussel", "fr": "Bruxelles" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/address/{type}Retrieve a specific enterprise address by type.Retrieve a specific address by the enterprise number and address type.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
-
type
string
Type of the address, see the response parameter for the type explaination.Possible values:branch
active-establishment
legal-entity
Example:legal-entity
Réponse
Successful response | The specific address has been found.
-
FieldTypeDescription
-
Address
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
type
string
The address type, possible values:branch
: Branch office
unit
: Establishment unit
*active-unit
: Active establishment unit
*legal-entity
: Head office
Possible values:branch
unit
active-unit
legal-entity
Example:branch
-
typeDescription
object
-
nl
string
Dutch descriptionExample:Maatschappelijke zetel
-
en
string
English descriptionExample:Head office
-
fr
string
French descriptionExample:Siège social
-
de
string
German descriptionExample:Sitzes Adresse
-
street
object
Street of the registration -
nl
string
Dutch street translation of the registrationExample:Kerkstraat
-
fr
string
French street translation of the registrationExample:Rue de l'Église
-
addressNumber
string
Address street number of the registrationExample:1
-
addressAdditional
string
Additional address or street suffixExample:Unit 12, Floor 5
-
postOfficeBox
string
The post office box of the address, if applicableExample:Box 5
-
zipcode
string
Zipcode of the registrationExample:2000
-
city
object
City of the registration -
nl
string
Dutch city translation of the registrationExample:Brussel
-
fr
string
French city translation of the registrationExample:Bruxelles
-
country
object
Country, is null if country is Belgium. -
nl
string
Dutch translation of the countryExample:Frankrijk
-
fr
string
French translation of the countryExample:France
-
dateRevoke
string
The revoke date of the address, could both be a date in the history or in the future.Example:2003-03-14
Exemple
200
Successful responseThe specific address has been found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/address/legal-entity
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.02765 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Address": { "entityNumber": 417497106, "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grand-Place" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "1000", "city": { "nl": "Brussel", "fr": "Bruxelles" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/contactNew! Large planRetrieve contact information of the enterprise.Retrieve contact information of the enterprise (phone numbers, email addresses and websites). Please note that companies aren't required to provide these details, so not all enterprises have contact information available.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Succesful response | All contact information of the enterprise.
-
FieldTypeDescription
-
[]
array
-
Contact
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
typeCode
string
The type of contact informationPossible values:phone
email
website
Example:phone
-
value
string
The value of the contact type, could be a phone number, email adress or website, depending on thetypeCode
.Example:0032123456789
Exemple
200
Succesful responseAll contact information of the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0443639002/contact
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.02503 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Contact": { "typeCode": "email", "value": "socialedienst@vlaanderen.be" } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/enterprise/{enterpriseNumber}/denominationsRetrieve all enterprise denominations.Retrieve all the denominations (business names and trade names) by the enterprise number.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | All denominations from the enterprise.
-
FieldTypeDescription
-
[]
array
-
Denomination
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
language
string
Possible values:unknown
nl
en
fr
Example:nl
-
value
string
The denomination nameExample:FaimMedia B.V.
-
type
string
The denomination typePossible values:social
abbreviation
commercial
Example:social
-
typeDescription
object
-
nl
string
Dutch translation of the type descriptionExample:Maatschappelijke naam
-
en
string
English translation of the type descriptionExample:Primary name
-
fr
string
French translation of the type descriptionExample:Dénomination sociale
-
de
string
German translation of the type descriptionExample:Primärname
Exemple
200
Successful responseAll denominations from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/denominations
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03743 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "fr", "value": "Anheuser-Busch InBev", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "nl", "value": "Anheuser-Busch InBev", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "unknown", "value": "ANHEUSER-BUSCH INBEV", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "unknown", "value": "AB Inbev", "type": "abbreviation", "typeDescription": { "nl": "Afkorting", "en": "Abbreviation", "fr": "Abréviation", "de": "Abkürzung" } } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/denomination/{language}/{type}Retrieve a specific enterprise denomination.Retrieve a specific type of denomination (business names and trade names) by the enterprise number and language.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
-
language
string
The language code of the denomination. Some denominations may not have the language specified, use theunknown
value in this case.Possible values:unknown
nl
en
fr
Example:nl
-
type
string
The type of the denomination, see the response parameter for the type explaination.Possible values:social
abbreviation
commercial
Example:commercial
Réponse
Successful response | The denomination has been found.
-
FieldTypeDescription
-
Denomination
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
language
string
Possible values:unknown
nl
en
fr
Example:nl
-
value
string
The denomination nameExample:FaimMedia B.V.
-
type
string
The denomination typePossible values:social
abbreviation
commercial
Example:social
-
typeDescription
object
-
nl
string
Dutch translation of the type descriptionExample:Maatschappelijke naam
-
en
string
English translation of the type descriptionExample:Primary name
-
fr
string
French translation of the type descriptionExample:Dénomination sociale
-
de
string
German translation of the type descriptionExample:Primärname
Exemple
200
Successful responseThe denomination has been found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/denomination/unknown/social
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.02536 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "unknown", "value": "ANHEUSER-BUSCH INBEV", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/establishmentsRetrieve all enterprise establishments.Retrieve all the establishments registered for this enterprise.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | All establishments from the enterprise.
-
FieldTypeDescription
-
[]
array
-
Establishment
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
establishmentNumber
string
The establishment number without punctuation marks.Example:2102217157
-
establishmentNumberFormatted
string
The estblishment number seperated by punctuation marks.Example:2102.217.157
-
dateStart
string
Example:2020-01-01
Exemple
200
Successful responseAll establishments from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/establishments
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03360 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Establishment": { "establishmentNumber": "2102217256", "establishmentNumberFormatted": "2.102.217.256", "dateStart": "1976-10-01" } }, { "Establishment": { "establishmentNumber": "2143775125", "establishmentNumberFormatted": "2.143.775.125", "dateStart": "1988-04-30" } }, { "Establishment": { "establishmentNumber": "2143775323", "establishmentNumberFormatted": "2.143.775.323", "dateStart": "1988-04-30" } }, { "Establishment": { "establishmentNumber": "2147197839", "establishmentNumberFormatted": "2.147.197.839", "dateStart": "2004-11-01" } }, { "Establishment": { "establishmentNumber": "2147842393", "establishmentNumberFormatted": "2.147.842.393", "dateStart": "2005-01-01" } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
/enterprise/{enterpriseNumber}/financialNew! Large planRetrieve short financial information of the enterprise.Retrieve short financial information of the enterprise, the following information is available:
- Paid-in capital
- Annual assembly
- Financial start and end year
Please note:
- sole-proprietorships do not have published financial years, so this information will not be available
- not all enterprises are required to publicly share this information, so it will not always be available.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | Financial information from the enterprise.
-
FieldTypeDescription
-
EnterpriseFinancial
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
capitalValue
integer
Placed capital according to statutesExample:100000
-
capitalValuta
string
The valuta of the placed capital, whileEUR
is the most common, this value can be anyISO-4217
code. It's also common for companies founded before the introduction of the Euro to have historical valuta, in example:BEF
,FRF
andNLG
. Most foreign companies have foreign valuta present.
Please visit wikipedia for an up-to-date ISO-4217 list of:
- Active currency codes
- Historic currency codesExample:EUR
-
annualAssembly
integer
The month of the annual assembly, range is 1 to 12.Example:6
-
annualAssemblyMonth
string
Textual presentation in English of the annual assembly.Example:June
-
fiscalEnd
string
The end date of a regular fiscal year. The year is not present here and will be formatted as0000
.Example:0000-12-21
-
fiscalSpecialStart
string
The start date of an exceptional fiscal year.Example:2021-03-01
-
fiscalSpecialEnd
string
The end date of an exceptional fiscal year.Example:2022-02-28
Exemple
200
Successful responseFinancial information from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/financial
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03706 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "EnterpriseFinancial": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "capitalValue": 1238608344.12, "capitalValuta": "EUR", "capitalFormatted": "1,238,608,344.12 EUR", "annualAssembly": "April", "annualAssemblyMonth": 4, "fiscalStart": null, "fiscalEnd": "0000-12-31", "fiscalSpecialStart": "2016-03-03", "fiscalSpecialEnd": "2016-12-31" } }
/enterprise/{enterpriseNumber}/rolesNew! Large planRetrieve all official functions of the enterprise.Retrieve all the official funtions registered for this enterprise (board of directors).
Please note:
- that sole proprietorships do not have any board members, except for the natural person that legally owns the company. This will be the only present function.
- almost all foreign entities do not have any board members registered.Arguments et paramètres
-
FieldTypeDescription
-
enterpriseNumber
integer
Number of the enterpriseExample:0417497106
Réponse
Successful response | All functions from the enterprise.
-
FieldTypeDescription
-
[]
array
-
EnterpriseRole
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
nameFirst
string
First name of the board memberExample:Frans
-
nameLast
string
Last name of the board memberExample:Vanderbeek
-
parentEnterpriseNumber
string
The enterprise number of which the role is inherited from. If thenameLast
andnameFirst
fields are both empty, the legal entity of the parent enterprise fulfills this role.Example:0417497105
-
parentEnterpriseNumberFormatted
string
The enterprise number formatted.Example:0417.497.106
-
dateInOffice
string
The date the person was registeredExample:2021-01-01
-
Role
object
-
roleCode
integer
Code of the function title. Please be aware that this code may change at anytime, so it's advisable not to put to much reference to this value. Or to check periodicly for any changes.Example:5
-
title
object
-
nl
string
Function title in DutchExample:Zaakvoerder
-
en
string
Function title in EnglishExample:Manager
-
fr
string
Function title in FrenchExample:Gérant
-
de
string
Function title in GermanExample:Geschäftsführer
-
note
object
Possible note regarding function title -
nl
string
Possible note regarding function title in DutchExample:Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term "Zaakvoerder" vanaf 1 januari 2020 gelezen worden als "Bestuurder"
-
en
string
Possible note regarding the function title in EnglishExample:Pursuant to the Code of Companies and Associations, the term "Manager" must, since January 1, 2020, be read as "Board member".
-
fr
string
Possible note regarding function title in FrenchExample:En application du Code des sociétés et des associations, le terme "Gérant" doit, depuis le 1er janvier 2020, être lu comme étant "Administrateur".
-
de
string
Possible note regarding function title in GermanExample:Gemäß dem Gesellschafts- und Vereinigungsgesetzbuch ist der Begriff "Geschäftsführer" seit dem 1. Januar 2020 als "Verwalter" zu lesen.
Exemple
200
Successful responseAll functions from the enterprise.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/enterprise/0417497106/roles
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03311 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "MARIA", "nameLast": "ARAMBURUZABALA LARREGUI", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "MARTIN", "nameLast": "BARRINGTON", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "MARTHA", "nameLast": "BURNS", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Sabine", "nameLast": "Chalmers", "dateInOffice": "2019-04-24", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Paul", "nameLast": "Cornet de Ways-Ruart", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "CARLOS", "nameLast": "DA VEIGA SICUPIRA", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Grégoire", "nameLast": "de Spoelberch", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "WILLIAM", "nameLast": "GIFFORD JR", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Paulo", "nameLast": "Lemann", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "ELIO", "nameLast": "LEONI SCETI", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Xiaozhi", "nameLast": "Liu", "dateInOffice": "2019-04-24", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Claudio", "nameLast": "Moniz Barreto Garcia", "dateInOffice": "2019-04-24", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "", "nameLast": "Moses Thompson Motta", "dateInOffice": "2020-06-03", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "ALEJANDRO", "nameLast": "SANTO DOMINGO", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Cecilia", "nameLast": "Sicupira", "dateInOffice": "2019-04-24", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } }, { "EnterpriseRole": { "enterpriseNumber": 417497106, "enterpriseNumberFormatted": "0417.497.106", "nameFirst": "Alexandre", "nameLast": "Van Damme", "dateInOffice": "2016-10-11", "parentEnterpriseNumber": null, "parentEnterpriseNumberFormatted": null, "Role": { "roleCode": 1, "title": { "nl": "Board member", "en": "Board member", "fr": "Board member", "de": "Board member", "es": "Board member" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } } ]
404
Enterprise not foundThe specified Enterprise number could not be found, please make sure the enterprise number is valid and correct.{ "exception": "RequestException", "error": "The `enterprise` item specified could not be found", "code": -2 }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/establishment/{establishmentNumber}Retrieve establishment details.Retrieve the establishment details by the establishment number.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
Réponse
Successful response | The establishment has been found.
-
FieldTypeDescription
-
Establishment
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
establishmentNumber
string
The establishment number without punctuation marks.Example:2102217157
-
establishmentNumberFormatted
string
The estblishment number seperated by punctuation marks.Example:2102.217.157
-
dateStart
string
Example:2020-01-01
Exemple
200
Successful responseThe establishment has been found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2147197839
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.02661 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Establishment": { "enterpriseNumber": "0417497106", "enterpriseNumberFormatted": "0417.497.106", "establishmentNumber": "2147197839", "establishmentNumberFormatted": "2.147.197.839", "dateStart": "2004-11-01" } }
404
Establishment not foundThe specified Establishment number could not be found, please make sure the establishment number is valid and correct.{ "exception": "RequestException", "error": "The `establishment` item specified could not be found", "code": -2 }
/establishment/{establishmentNumber}/activitiesRetrieve all establishment activities.Retrieve all activities by the establishment number.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
Réponse
Successful response | All activities from the establishment.
-
FieldTypeDescription
-
[]
array
-
Activity
object
-
activityGroup
string
Possible values:BTW001
EDR001
OLK001
POR001
PPO001
RSZ001
SCO001
Example:BTW001
-
activityGroupDescription
object
-
nl
string
Dutch descriptionExample:BTW-activiteiten
-
fr
string
French descriptionExample:Activités TVA
-
en
string
English descriptionExample:VAT activities
-
de
string
German descriptionExample:MwSt.-Aktivitäten
-
classification
string
Possible values:ANCI
MAIN
SECO
Example:MAIN
-
classificationDescription
object
-
nl
string
Dutch descriptionExample:Hoofdactiviteit
-
fr
string
French descriptionExample:Activité principale
-
en
string
English descriptionExample:Main activity
-
de
string
German descriptionExample:Hauptaktivität
-
Nace
object
-
naceVersion
integer
Example:2008
-
naceCode
string
Example:474
-
description
object
-
nl
string
Dutch descriptionExample:Detailhandel in ICT-apparatuur in gespecialiseerde winkels
-
fr
string
French descriptionExample:Commerce de détail d'équipements de l'information et de la communication en magasin spécialisé
Exemple
200
Successful responseAll activities from the establishment.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2147197839/activities
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03254 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Activity": { "activityGroup": "003", "activityGroupDescription": { "nl": "Activiteiten", "en": "Activities", "fr": "Activités", "de": "Aktivitäten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2003, "naceCode": "65231", "description": { "nl": "Financiële holdings", "fr": "Holdings financiers" } } } }, { "Activity": { "activityGroup": "003", "activityGroupDescription": { "nl": "Activiteiten", "en": "Activities", "fr": "Activités", "de": "Aktivitäten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2008, "naceCode": "64200", "description": { "nl": "Holdings", "fr": "Activités des sociétés holding" } } } }, { "Activity": { "activityGroup": "006", "activityGroupDescription": { "nl": "RSZ-activiteiten", "en": "NOSS activities", "fr": "Activités ONSS", "de": "LSS-Tätigkeiten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2003, "naceCode": "74151", "description": { "nl": "Managementactiviteiten van holdings", "fr": "Activités de gestion et d'administration de holdings" } } } }, { "Activity": { "activityGroup": "006", "activityGroupDescription": { "nl": "RSZ-activiteiten", "en": "NOSS activities", "fr": "Activités ONSS", "de": "LSS-Tätigkeiten" }, "classification": "MAIN", "classificationDescription": { "nl": "Hoofdactiviteit", "en": "Main activity", "fr": "Activité principale", "de": "Hauptaktivität" }, "Nace": { "naceVersion": 2008, "naceCode": "70100", "description": { "nl": "Activiteiten van hoofdkantoren", "fr": "Activités des sièges sociaux" } } } } ]
404
Establishment not foundThe specified Establishment number could not be found, please make sure the establishment number is valid and correct.{ "exception": "RequestException", "error": "The `establishment` item specified could not be found", "code": -2 }
/establishment/{establishmentNumber}/addressRetrieve the address of the establishment address.Retrieve the address of the establishment.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
Réponse
Successful response | The specific address has been found.
-
FieldTypeDescription
-
Address
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
type
string
The address type, possible values:branch
: Branch office
unit
: Establishment unit
*active-unit
: Active establishment unit
*legal-entity
: Head office
Possible values:branch
unit
active-unit
legal-entity
Example:branch
-
typeDescription
object
-
nl
string
Dutch descriptionExample:Maatschappelijke zetel
-
en
string
English descriptionExample:Head office
-
fr
string
French descriptionExample:Siège social
-
de
string
German descriptionExample:Sitzes Adresse
-
street
object
Street of the registration -
nl
string
Dutch street translation of the registrationExample:Kerkstraat
-
fr
string
French street translation of the registrationExample:Rue de l'Église
-
addressNumber
string
Address street number of the registrationExample:1
-
addressAdditional
string
Additional address or street suffixExample:Unit 12, Floor 5
-
postOfficeBox
string
The post office box of the address, if applicableExample:Box 5
-
zipcode
string
Zipcode of the registrationExample:2000
-
city
object
City of the registration -
nl
string
Dutch city translation of the registrationExample:Brussel
-
fr
string
French city translation of the registrationExample:Bruxelles
-
country
object
Country, is null if country is Belgium. -
nl
string
Dutch translation of the countryExample:Frankrijk
-
fr
string
French translation of the countryExample:France
-
dateRevoke
string
The revoke date of the address, could both be a date in the history or in the future.Example:2003-03-14
Exemple
200
Successful responseThe specific address has been found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2147197839/address
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.02335 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Address": { "entityNumber": 2147197839, "entityNumberFormatted": "2.147.197.839", "entityType": "establishment", "type": "establishment", "typeDescription": { "nl": "Vestigingseenheid", "en": "Establishment unit", "fr": "Unité d'établissement", "de": "Niederlassungseinheit" }, "street": { "nl": "Industrielaan", "fr": "Boulevard Industriel" }, "addressNumber": "21", "addressAdditional": "", "postOfficeBox": "", "zipcode": "1070", "city": { "nl": "Anderlecht", "fr": "Anderlecht" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }
404
Establishment not foundThe specified Establishment number could not be found, please make sure the establishment number is valid and correct.{ "exception": "RequestException", "error": "The `establishment` item specified could not be found", "code": -2 }
/establishment/{establishmentNumber}/contactNew! Large planRetrieve contact information of the establishment.Retrieve contact information of the establishment (phone numbers, email addresses and websites). Please note that companies aren't required to provide these details, so not all establishment have contact information available.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
Réponse
Succesful response | All contact information of the establishment.
-
FieldTypeDescription
-
[]
array
-
Contact
object
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
-
typeCode
string
The type of contact informationPossible values:phone
email
website
Example:phone
-
value
string
The value of the contact type, could be a phone number, email adress or website, depending on thetypeCode
.Example:0032123456789
Exemple
200
Succesful responseAll contact information of the establishment.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2159319869/contact
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 254 X-API-Search-Request-Limit: X-Parse-Time: 0.03816 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Contact": { "typeCode": "phone", "value": "092761088" } }, { "Contact": { "typeCode": "email", "value": "opera.voor.vlaanderen@vlaanderen.be" } } ]
404
Establishment not foundThe specified Establishment number could not be found, please make sure the establishment number is valid and correct.{ "exception": "RequestException", "error": "The `establishment` item specified could not be found", "code": -2 }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/establishment/{establishmentNumber}/denominationsRetrieve all establishment denominations.Retrieve all the denominations (business names and trade names) by the establishment number.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
Réponse
Successful response | All denominations from the establishment.
-
FieldTypeDescription
-
[]
array
-
Denomination
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
language
string
Possible values:unknown
nl
en
fr
Example:nl
-
value
string
The denomination nameExample:FaimMedia B.V.
-
type
string
The denomination typePossible values:social
abbreviation
commercial
Example:social
-
typeDescription
object
-
nl
string
Dutch translation of the type descriptionExample:Maatschappelijke naam
-
en
string
English translation of the type descriptionExample:Primary name
-
fr
string
French translation of the type descriptionExample:Dénomination sociale
-
de
string
German translation of the type descriptionExample:Primärname
Exemple
200
Successful responseAll denominations from the establishment.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2147197839/denominations
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03864 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
[ { "Denomination": { "entityNumber": "2147197839", "entityNumberFormatted": "2.147.197.839", "entityType": "establishment", "language": "nl", "value": "Anheuser-Busch InBev", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } } ]
404
Establishment not foundThe specified Establishment number could not be found, please make sure the establishment number is valid and correct.{ "exception": "RequestException", "error": "The `establishment` item specified could not be found", "code": -2 }
/establishment/{establishmentNumber}/denomination/{language}/{type}Retrieve a specific establishment denomination.Retrieve a specific type of denomination (business names and trade names) by the establishment number and language.Arguments et paramètres
-
FieldTypeDescription
-
establishmentNumber
integer
Number of the establishmentExample:2147197839
-
language
string
The language code of the denomination. Some denominations may not have the language specified, use theunknown
value in this case.Possible values:unknown
nl
en
fr
Example:nl
-
type
string
The type of the denomination, see the response parameter for the type explaination.Possible values:social
abbreviation
commercial
Example:commercial
Réponse
Successful response | The denomination has been found.
-
FieldTypeDescription
-
Denomination
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
language
string
Possible values:unknown
nl
en
fr
Example:nl
-
value
string
The denomination nameExample:FaimMedia B.V.
-
type
string
The denomination typePossible values:social
abbreviation
commercial
Example:social
-
typeDescription
object
-
nl
string
Dutch translation of the type descriptionExample:Maatschappelijke naam
-
en
string
English translation of the type descriptionExample:Primary name
-
fr
string
French translation of the type descriptionExample:Dénomination sociale
-
de
string
German translation of the type descriptionExample:Primärname
Exemple
200
Successful responseThe denomination has been found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/establishment/2147197839/denomination/nl/commercial
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03726 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Denomination": { "entityNumber": "2147197839", "entityNumberFormatted": "2.147.197.839", "entityType": "establishment", "language": "nl", "value": "Anheuser-Busch InBev", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }
404
Item or resource not foundThe item or resource specified could not be found{ "exception": "RequestException", "error": "The item specified could not be found", "code": -2 }
/denominationsSearch requestAutocomplete trade names (denominations)Search for denominations (trade name) by using keywords. Both enterprises and establishments can have one or more denominations. Although an enterprise almost always has at lease one denominations, this must not be assumed. So it is adviced to verify any denominations that belong to the enterprise' establishments.Arguments et paramètres
-
FieldTypeDescription
-
query
string
The keywords to search for the denominations.Example:AB Inbev
-
entityType
string
Accepted values: enterprise: show only enterprises, establishment: show only establishmentsPossible values:enterprise
establishment
Example:enterprise
-
type
string
Filter on the type of denomination.Possible values:social
abbreviation
commercial
Example:commercial
-
language
string
Search only in this language specified fieldsPossible values:nl
fr
Example:nl
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All denominations matching the provided search criteria.
-
FieldTypeDescription
-
Denominations
array
-
Demomination
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
language
string
Possible values:unknown
nl
en
fr
Example:nl
-
value
string
The denomination nameExample:FaimMedia B.V.
-
type
string
The denomination typePossible values:social
abbreviation
commercial
Example:social
-
typeDescription
object
-
nl
string
Dutch translation of the type descriptionExample:Maatschappelijke naam
-
en
string
English translation of the type descriptionExample:Primary name
-
fr
string
French translation of the type descriptionExample:Dénomination sociale
-
de
string
German translation of the type descriptionExample:Primärname
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll denominations matching the provided search criteria.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/denominations?query=AB+Inbev
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 254 X-API-Search-Request-Limit: X-Parse-Time: 0.02195 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Denominations": [ { "Denomination": { "entityNumber": "0447393001", "entityNumberFormatted": "0447.393.001", "entityType": "enterprise", "language": "nl", "value": "PENSIOENFONDS INBEV BEDIENDEN EN ARBEIDERS", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0447393001", "entityNumberFormatted": "0447.393.001", "entityType": "enterprise", "language": "unknown", "value": "Fonds de Pension INBEV, employés et ouvriers A.S.B.L.", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0461997637", "entityNumberFormatted": "0461.997.637", "entityType": "enterprise", "language": "nl", "value": "PENSIOENFONDS INBEV - KADERLEDEN", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0734781730", "entityNumberFormatted": "0734.781.730", "entityType": "enterprise", "language": "nl", "value": "inbev nederland bv", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0862316340", "entityNumberFormatted": "0862.316.340", "entityType": "enterprise", "language": "nl", "value": "ANHEUSER-BUSCH INBEV INTERNATIONAL GMBH & CO KG", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0873332768", "entityNumberFormatted": "0873.332.768", "entityType": "enterprise", "language": "nl", "value": "INBEV NEDERLAND", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "2272532727", "entityNumberFormatted": "2.272.532.727", "entityType": "establishment", "language": "fr", "value": "INBEV", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2297616729", "entityNumberFormatted": "2.297.616.729", "entityType": "establishment", "language": "fr", "value": "Jupille (AB Inbev)", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2297617422", "entityNumberFormatted": "2.297.617.422", "entityType": "establishment", "language": "nl", "value": "Stellarant (AB Inbev)", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "fr", "value": "Anheuser-Busch InBev", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "nl", "value": "Anheuser-Busch InBev", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "unknown", "value": "ANHEUSER-BUSCH INBEV", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0417497106", "entityNumberFormatted": "0417.497.106", "entityType": "enterprise", "language": "unknown", "value": "AB Inbev", "type": "abbreviation", "typeDescription": { "nl": "Afkorting", "en": "Abbreviation", "fr": "Abréviation", "de": "Abkürzung" } } }, { "Denomination": { "entityNumber": "0433666709", "entityNumberFormatted": "0433.666.709", "entityType": "enterprise", "language": "nl", "value": "INBEV BELGIUM", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "0784648143", "entityNumberFormatted": "0784.648.143", "entityType": "enterprise", "language": "nl", "value": "AB InBev Solidarity Fund", "type": "social", "typeDescription": { "nl": "Maatschappelijke naam", "en": "Primary name", "fr": "Dénomination sociale", "de": "Primärname" } } }, { "Denomination": { "entityNumber": "2111587753", "entityNumberFormatted": "2.111.587.753", "entityType": "establishment", "language": "nl", "value": "INBEV BELGIUM", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2111588842", "entityNumberFormatted": "2.111.588.842", "entityType": "establishment", "language": "nl", "value": "INBEV BELGIUM", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2111589535", "entityNumberFormatted": "2.111.589.535", "entityType": "establishment", "language": "fr", "value": "INBEV BELGIUM", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2111591515", "entityNumberFormatted": "2.111.591.515", "entityType": "establishment", "language": "nl", "value": "INBEV BELGIUM", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } }, { "Denomination": { "entityNumber": "2111591614", "entityNumberFormatted": "2.111.591.614", "entityType": "establishment", "language": "nl", "value": "INBEV BELGIUM", "type": "commercial", "typeDescription": { "nl": "Commerciële naam", "en": "Trade name", "fr": "Dénomination commerciale", "de": "Handelsname" } } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 2, "totalItems": 34, "countItems": 20 } }
400
bad input parameter/addressesSearch requestSearch for multiple addresses.Search for multiple addresses by query parameter.Arguments et paramètres
-
FieldTypeDescription
-
query
string
Search queryExample:Grote Markt
-
type
string
Search for a specific address type.
(may be slow for many results, so use with caution)
Possible values:branch
: Branch
establishment
: Location unit
active-establishment
: Active establishment unit
legal-entity
: Registered Office
Possible values:branch
establishment
active-establishment
legal-entity
Example:branch
-
fields[]
array
Provide the fields that need to be queried. Possible values:
*street
: Search in the street fieldzipcode
: Search in the zipcode field
city
: Search in the city field
country
: Search in the country field
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All addresses matching the provided search criteria.
-
FieldTypeDescription
-
Addresses
array
-
Address
object
-
entityNumber
string
Example:0417497106
-
entityNumberFormatted
string
Example:0417.497.106
-
entityType
string
Possible values:enterprise
establishment
Example:enterprise
-
type
string
The address type, possible values:branch
: Branch office
unit
: Establishment unit
*active-unit
: Active establishment unit
*legal-entity
: Head office
Possible values:branch
unit
active-unit
legal-entity
Example:branch
-
typeDescription
object
-
nl
string
Dutch descriptionExample:Maatschappelijke zetel
-
en
string
English descriptionExample:Head office
-
fr
string
French descriptionExample:Siège social
-
de
string
German descriptionExample:Sitzes Adresse
-
street
object
Street of the registration -
nl
string
Dutch street translation of the registrationExample:Kerkstraat
-
fr
string
French street translation of the registrationExample:Rue de l'Église
-
addressNumber
string
Address street number of the registrationExample:1
-
addressAdditional
string
Additional address or street suffixExample:Unit 12, Floor 5
-
postOfficeBox
string
The post office box of the address, if applicableExample:Box 5
-
zipcode
string
Zipcode of the registrationExample:2000
-
city
object
City of the registration -
nl
string
Dutch city translation of the registrationExample:Brussel
-
fr
string
French city translation of the registrationExample:Bruxelles
-
country
object
Country, is null if country is Belgium. -
nl
string
Dutch translation of the countryExample:Frankrijk
-
fr
string
French translation of the countryExample:France
-
dateRevoke
string
The revoke date of the address, could both be a date in the history or in the future.Example:2003-03-14
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll addresses matching the provided search criteria.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/addresses?query=Grote+Markt
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Search-Fields: street_nl, street_fr, city_nl, city_fr, zipcode X-Parse-Time: 0.03606 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Addresses": [ { "Address": { "entityNumber": 202082078, "entityNumberFormatted": "0202.082.078", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "Z\/N", "addressAdditional": "STADHUIS", "postOfficeBox": "", "zipcode": "1800", "city": { "nl": "Vilvoorde", "fr": "Vilvoorde" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 206751837, "entityNumberFormatted": "0206.751.837", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8970", "city": { "nl": "Poperinge", "fr": "Poperinge" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 206848639, "entityNumberFormatted": "0206.848.639", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt(Kor)", "fr": "Grote Markt(Kor)" }, "addressNumber": "ZN", "addressAdditional": "Stadhuis", "postOfficeBox": "", "zipcode": "8500", "city": { "nl": "Kortrijk", "fr": "Kortrijk" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 207433312, "entityNumberFormatted": "0207.433.312", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8930", "city": { "nl": "Menen", "fr": "Menen" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 207449346, "entityNumberFormatted": "0207.449.346", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "9060", "city": { "nl": "Zelzate", "fr": "Zelzate" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 207464192, "entityNumberFormatted": "0207.464.192", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "1", "addressAdditional": "", "postOfficeBox": "", "zipcode": "9100", "city": { "nl": "Sint-Niklaas", "fr": "Sint-Niklaas" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-01-13" } }, { "Address": { "entityNumber": 454106983, "entityNumberFormatted": "0454.106.983", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "6", "addressAdditional": "", "postOfficeBox": "A", "zipcode": "9100", "city": { "nl": "Sint-Niklaas", "fr": "Sint-Niklaas" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 480548391, "entityNumberFormatted": "0480.548.391", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "6", "addressAdditional": "", "postOfficeBox": "A", "zipcode": "9100", "city": { "nl": "Sint-Niklaas", "fr": "Sint-Niklaas" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 560928135, "entityNumberFormatted": "0560.928.135", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "11", "addressAdditional": "", "postOfficeBox": "", "zipcode": "2800", "city": { "nl": "Mechelen", "fr": "Mechelen" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 668552209, "entityNumberFormatted": "0668.552.209", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "36", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8870", "city": { "nl": "Izegem", "fr": "Izegem" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 727604720, "entityNumberFormatted": "0727.604.720", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "11", "addressAdditional": "", "postOfficeBox": "", "zipcode": "2800", "city": { "nl": "Mechelen", "fr": "Mechelen" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 779949482, "entityNumberFormatted": "0779.949.482", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "45", "addressAdditional": "", "postOfficeBox": "4", "zipcode": "3300", "city": { "nl": "Tienen", "fr": "Tienen" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 780432504, "entityNumberFormatted": "0780.432.504", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "35", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8870", "city": { "nl": "Izegem", "fr": "Izegem" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 780597602, "entityNumberFormatted": "0780.597.602", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "10", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8630", "city": { "nl": "Veurne", "fr": "Veurne" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 780733796, "entityNumberFormatted": "0780.733.796", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt(D)", "fr": "Grote Markt(D)" }, "addressNumber": "39", "addressAdditional": "", "postOfficeBox": "", "zipcode": "8600", "city": { "nl": "Diksmuide", "fr": "Diksmuide" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 780762403, "entityNumberFormatted": "0780.762.403", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "52", "addressAdditional": "", "postOfficeBox": "", "zipcode": "3800", "city": { "nl": "Sint-Truiden", "fr": "Sint-Truiden" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 886187347, "entityNumberFormatted": "0886.187.347", "entityType": "enterprise", "type": "legal-entity", "typeDescription": { "nl": "Maatschappelijke zetel", "en": "Head office", "fr": "Siège social", "de": "Hauptsitz" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "6", "addressAdditional": "", "postOfficeBox": "A", "zipcode": "9100", "city": { "nl": "Sint-Niklaas", "fr": "Sint-Niklaas" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 2214420225, "entityNumberFormatted": "2.214.420.225", "entityType": "establishment", "type": "establishment", "typeDescription": { "nl": "Vestigingseenheid", "en": "Establishment unit", "fr": "Unité d'établissement", "de": "Niederlassungseinheit" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "21", "addressAdditional": "", "postOfficeBox": "", "zipcode": "2300", "city": { "nl": "Turnhout", "fr": "Turnhout" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 2230768485, "entityNumberFormatted": "2.230.768.485", "entityType": "establishment", "type": "establishment", "typeDescription": { "nl": "Vestigingseenheid", "en": "Establishment unit", "fr": "Unité d'établissement", "de": "Niederlassungseinheit" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "71\/A", "addressAdditional": "", "postOfficeBox": "", "zipcode": "9060", "city": { "nl": "Zelzate", "fr": "Zelzate" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } }, { "Address": { "entityNumber": 2289519110, "entityNumberFormatted": "2.289.519.110", "entityType": "establishment", "type": "establishment", "typeDescription": { "nl": "Vestigingseenheid", "en": "Establishment unit", "fr": "Unité d'établissement", "de": "Niederlassungseinheit" }, "street": { "nl": "Grote Markt", "fr": "Grote Markt" }, "addressNumber": "11", "addressAdditional": "", "postOfficeBox": "", "zipcode": "2800", "city": { "nl": "Mechelen", "fr": "Mechelen" }, "country": { "nl": null, "fr": null }, "dateRevoke": "2022-02-21" } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 835, "totalItems": 16689, "countItems": 20 } }
422
Invalid response, missing or incorrect parameter{ "exception": [], "error": [], "code": [] }
/nacesSearch requestSearch for nace codeArguments et paramètres
-
FieldTypeDescription
-
query
string
Search queryExample:ICT-apparatuur
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All NACEs matching the provided search criteria.
-
FieldTypeDescription
-
Naces
array
-
Nace
object
-
naceVersion
integer
Example:2008
-
naceCode
string
Example:474
-
description
object
-
nl
string
Dutch descriptionExample:Detailhandel in ICT-apparatuur in gespecialiseerde winkels
-
fr
string
French descriptionExample:Commerce de détail d'équipements de l'information et de la communication en magasin spécialisé
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll NACEs matching the provided search criteria.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/naces?query=ICT-apparatuur
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.02887 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Naces": [ { "Nace": { "naceVersion": 2008, "naceCode": "474", "description": { "nl": "Detailhandel in ICT-apparatuur in gespecialiseerde winkels", "fr": "Commerce de détail d'équipements de l'information et de la communication en magasin spécialisé" } } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 1, "totalItems": 1, "countItems": 1 } }
/nace/{naceVersion}/{naceCode}Get NACE by version and codeArguments et paramètres
-
FieldTypeDescription
-
naceVersion
integer
NACE versionExample:2003
-
naceCode
string
NACE codeExample:01
Réponse
Successful response, NACE is found.
-
FieldTypeDescription
-
Nace
object
-
naceVersion
integer
Example:2008
-
naceCode
string
Example:474
-
description
object
-
nl
string
Dutch descriptionExample:Detailhandel in ICT-apparatuur in gespecialiseerde winkels
-
fr
string
French descriptionExample:Commerce de détail d'équipements de l'information et de la communication en magasin spécialisé
Exemple
200
Successful response, NACE is found.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/nace/2003/01
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03548 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Nace": { "naceVersion": 2003, "naceCode": "01", "description": { "nl": "Landbouw, jacht en diensten in verband met deze activiteiten", "fr": "Culture de céréales et horticulture" } } }
/rolesNew! Large plan Search requestSearch for a role code (function title)Arguments et paramètres
-
FieldTypeDescription
-
query
string
Search query, will search for a partial role titleExample:Manager
-
language
string
Specify in which language should be searched. If this parameter is omitted, all available languages will be searched.Possible values:nl
en
fr
de
Example:en
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All function titles returned
-
FieldTypeDescription
-
Roles
array
-
Role
object
-
roleCode
integer
Code of the function title. Please be aware that this code may change at anytime, so it's advisable not to put to much reference to this value. Or to check periodicly for any changes.Example:5
-
title
object
-
nl
string
Function title in DutchExample:Zaakvoerder
-
en
string
Function title in EnglishExample:Manager
-
fr
string
Function title in FrenchExample:Gérant
-
de
string
Function title in GermanExample:Geschäftsführer
-
note
object
Possible note regarding function title -
nl
string
Possible note regarding function title in DutchExample:Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term "Zaakvoerder" vanaf 1 januari 2020 gelezen worden als "Bestuurder"
-
en
string
Possible note regarding the function title in EnglishExample:Pursuant to the Code of Companies and Associations, the term "Manager" must, since January 1, 2020, be read as "Board member".
-
fr
string
Possible note regarding function title in FrenchExample:En application du Code des sociétés et des associations, le terme "Gérant" doit, depuis le 1er janvier 2020, être lu comme étant "Administrateur".
-
de
string
Possible note regarding function title in GermanExample:Gemäß dem Gesellschafts- und Vereinigungsgesetzbuch ist der Begriff "Geschäftsführer" seit dem 1. Januar 2020 als "Verwalter" zu lesen.
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll function titles returnedcurl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/roles?query=Manager
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.03246 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Roles": [ { "Role": { "roleCode": 6, "title": { "nl": "Zaakvoerder", "en": "Manager", "fr": "Gérant", "de": "Geschäftsführer", "es": "Zaakvoerder" }, "note": { "nl": "Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term ‘Zaakvoerder’ vanaf 1 mei 2019 gelezen worden als ‘Bestuurder’.", "en": "Pursuant to the Code of Companies and Associations, the term ‘Manager’ must, since May 1, 2019, be read as ‘Board member’.", "fr": "En application du Code des sociétés et des associations, le terme ‘Gérant’ doit, depuis le 1er mai 2019, être lu comme étant ‘Administrateur’.", "de": "Gemäß dem Gesellschafts- und Vereinigungsgesetzbuch ist der Begriff ‘Geschäftsführer’ seit dem 1. Mai 2019 als ‘Verwalter’ zu lesen.", "es": "Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term ‘Zaakvoerder’ vanaf 1 mei 2019 gelezen worden als ‘Bestuurder’." } } }, { "Role": { "roleCode": 28, "title": { "nl": "Syndicus", "en": "Property manager", "fr": "Syndic", "de": "Hausverwalter", "es": "Syndicus" }, "note": { "nl": null, "en": null, "fr": null, "de": null, "es": null } } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 1, "totalItems": 2, "countItems": 2 } }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/role/{roleCode}New! Large planGet a specific function title by codeArguments et paramètres
-
FieldTypeDescription
-
roleCode
integer
The role codeExample:5
Réponse
Successful response | Function title is returned
-
FieldTypeDescription
-
Role
object
-
roleCode
integer
Code of the function title. Please be aware that this code may change at anytime, so it's advisable not to put to much reference to this value. Or to check periodicly for any changes.Example:5
-
title
object
-
nl
string
Function title in DutchExample:Zaakvoerder
-
en
string
Function title in EnglishExample:Manager
-
fr
string
Function title in FrenchExample:Gérant
-
de
string
Function title in GermanExample:Geschäftsführer
-
note
object
Possible note regarding function title -
nl
string
Possible note regarding function title in DutchExample:Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term "Zaakvoerder" vanaf 1 januari 2020 gelezen worden als "Bestuurder"
-
en
string
Possible note regarding the function title in EnglishExample:Pursuant to the Code of Companies and Associations, the term "Manager" must, since January 1, 2020, be read as "Board member".
-
fr
string
Possible note regarding function title in FrenchExample:En application du Code des sociétés et des associations, le terme "Gérant" doit, depuis le 1er janvier 2020, être lu comme étant "Administrateur".
-
de
string
Possible note regarding function title in GermanExample:Gemäß dem Gesellschafts- und Vereinigungsgesetzbuch ist der Begriff "Geschäftsführer" seit dem 1. Januar 2020 als "Verwalter" zu lesen.
Exemple
200
Successful responseFunction title is returnedcurl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/role/5
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.02597 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Role": { "roleCode": 5, "title": { "nl": "Gedelegeerd bestuurder", "en": "Managing Director", "fr": "Administrateur délégué", "de": "beauftragter Verwalter", "es": "Gedelegeerd bestuurder" }, "note": { "nl": "Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term ‘Bestuurder’ vanaf 1 januari 2020 gelezen worden als ‘Zaakvoerder’.", "en": "Pursuant to the Code of Companies and Associations, the term ‘Board member’ must, since January 1, 2020, be read as ‘Manager’.", "fr": "En application du Code des sociétés et des associations, le terme ‘Administrateur’ doit, depuis le 1er janvier 2020, être lu comme étant ‘Gérant’.", "de": "Gemäß dem Gesellschafts- und Vereinigungsgesetzbuch ist der Begriff ‘Verwalter’ seit dem 1. Januar 2020 als ‘Geschäftsführer’ zu lesen.", "es": "Overeenkomstig het Wetboek van Vennootschappen en Verenigingen moet de term ‘Bestuurder’ vanaf 1 januari 2020 gelezen worden als ‘Zaakvoerder’." } } }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
404
Item or resource not foundThe item or resource specified could not be found{ "exception": "RequestException", "error": "The item specified could not be found", "code": -2 }
/juridical-formsNew! Large plan Search requestSearch for a juridical formArguments et paramètres
-
FieldTypeDescription
-
query
string
Search query, will search for a (partial) juridical formExample:Vennoot
-
language
string
Specify in which language should be searched. If this parameter is omitted, all available languages will be searched.Possible values:nl
fr
de
Example:nl
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All juridical forms matching your search criteria are returned.
-
FieldTypeDescription
-
JuridicalForms
array
-
JuridicalForm
object
-
juridicalFormCode
string
Juridical Form codeExample:030
-
description
object
-
nl
string
Dutch description of the juridical formExample:Buitenlandse entiteit
-
fr
string
French description of the juridical formExample:Entité étrangère
-
de
string
German description of the juridical formExample:Ausländische Einheit
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll juridical forms matching your search criteria are returned.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/juridical-forms?query=Vennoot
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 254 X-API-Search-Request-Limit: X-Parse-Time: 0.03374 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "JuridicalForms": [ { "JuridicalForm": { "juridicalFormCode": "001", "description": { "nl": "Europese Coöperatieve Vennootschap", "fr": "Société coopérative européenne", "de": "Europäische Genossenschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "006", "description": { "nl": "Coöperatieve vennootschap met onbeperkte aansprakelijkheid", "fr": "Société coopérative à responsabilité illimitée", "de": "Genossenschaft mit unbeschränkter Haftung" } } }, { "JuridicalForm": { "juridicalFormCode": "007", "description": { "nl": "Coöperatieve vennootschap met onbeperkte aansprakelijkheid, bij wijze van deelneming", "fr": "Société coopérative à responsabilité illimitée et solidaire, société coopérative de participation", "de": "Genossenschaft mit unbeschränkter gesamtschuldnerischer Haftung, Genossenschaft auf Beteiligung" } } }, { "JuridicalForm": { "juridicalFormCode": "008", "description": { "nl": "Coöperatieve vennootschap met beperkte aansprakelijkheid", "fr": "Société coopérative à responsabilité limitée", "de": "Genossenschaft mit beschränkter Haftung" } } }, { "JuridicalForm": { "juridicalFormCode": "009", "description": { "nl": "Coöperatieve vennootschap met beperkte aansprakelijkheid, bij wijze van deelneming", "fr": "Société coopérative à responsabilité limitée, coopérative de participation", "de": "Genossenschaft mit beschränkter Haftung, Genossenschaft auf Beteiligung" } } }, { "JuridicalForm": { "juridicalFormCode": "010", "description": { "nl": "Eenpersoons besloten vennootschap met beperkte aansprakelijkheid", "fr": "Société privée à responsabilité limitée unipersonnelle", "de": "Privatgesellschaft mit beschränkter Haftung mit einem Alleingesellschafter" } } }, { "JuridicalForm": { "juridicalFormCode": "011", "description": { "nl": "Vennootschap onder firma", "fr": "Société en nom collectif", "de": "Offene Handelsgesellschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "012", "description": { "nl": "Gewone commanditaire vennootschap", "fr": "Société en commandite simple", "de": "Einfache Kommanditgesellschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "013", "description": { "nl": "Commanditaire vennootschap op aandelen", "fr": "Société en commandite par actions", "de": "Kommanditgesellschaft auf Aktien" } } }, { "JuridicalForm": { "juridicalFormCode": "014", "description": { "nl": "Naamloze vennootschap", "fr": "Société anonyme", "de": "Aktiengesellschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "015", "description": { "nl": "Besloten vennootschap met beperkte aansprakelijkheid", "fr": "Société privée à responsabilité limitée", "de": "Privatgesellschaft mit beschränkter Haftung" } } }, { "JuridicalForm": { "juridicalFormCode": "016", "description": { "nl": "Coöperatieve vennootschap (oud statuut)", "fr": "Société coopérative (ancien statut)", "de": "Genossenschaft (früheres Statut)" } } }, { "JuridicalForm": { "juridicalFormCode": "025", "description": { "nl": "Landbouwvennootschap", "fr": "Société agricole", "de": "Landwirtschaftliche Gesellschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "027", "description": { "nl": "Europese vennootschap (Societas Europaea)", "fr": "Société européenne (Societas Europaea)", "de": "Europäische Gesellschaft (Societas Europaea)" } } }, { "JuridicalForm": { "juridicalFormCode": "040", "description": { "nl": "Kongolese vennootschap", "fr": "Société congolaise (loi de 1927)", "de": "Kongolesische Gesellschaft" } } }, { "JuridicalForm": { "juridicalFormCode": "106", "description": { "nl": "Coöperatieve vennootschap met onbeperkte aansprakelijkheid van publiek recht", "fr": "Société coopérative à responsabilité illimitée de droit public", "de": "Öffentlich-rechtliche Genossenschaft mit unbeschränkter Haftung" } } }, { "JuridicalForm": { "juridicalFormCode": "107", "description": { "nl": "Coöperatieve vennootschap met onbeperkte aansprakelijkheid, bij wijze van deelneming van publiek recht", "fr": "Coopérative à responsabilité illimitée, coopérative de participation, de droit public", "de": "Öffentlich-rechtliche Genossenschaft mit unbeschränkter Haftung, Genossenschaft auf Beteiligung" } } }, { "JuridicalForm": { "juridicalFormCode": "108", "description": { "nl": "Coöperatieve vennootschap met beperkte aansprakelijkheid van publiek recht", "fr": "Société coopérative à responsabilité limitée de droit public", "de": "Öffentlich-rechtliche Genossenschaft mit beschränkter Haftung" } } }, { "JuridicalForm": { "juridicalFormCode": "109", "description": { "nl": "Coöperatieve vennootschap met beperkte aansprakelijkheid, bij wijze van deelneming, van publiek recht", "fr": "Société coopérative à responsabilité limitée, coopérative de participation, de droit public", "de": "Öffentlich-rechtliche Genossenschaft mit beschränkter Haftung, Genossenschaft auf Beteiligung" } } }, { "JuridicalForm": { "juridicalFormCode": "114", "description": { "nl": "Naamloze vennootschap van publiek recht", "fr": "Société anonyme de droit public", "de": "Öffentlich-rechtliche Aktiengesellschaft" } } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 3, "totalItems": 51, "countItems": 20 } }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/juridical-situationsNew! Large plan Search requestSearch for a juridical situationArguments et paramètres
-
FieldTypeDescription
-
query
string
Search query, will search for a (partial) juridical situationExample:Stop
-
language
string
Specify in which language should be searched. If this parameter is omitted, all available languages will be searched.Possible values:nl
fr
de
Example:nl
-
page
integer
The page of the results that should be returnedExample:2
-
limit
integer
The limit of results that should be returned, can be a value somewhere between 1 and your plan's maximum. If a higher value is used, this parameter is ignored and your plan's maximum is used instead.Example:30
Réponse
Successful response | All juridical situations matching your search criteria are returned.
-
FieldTypeDescription
-
JuridicalSituations
array
-
JuridicalSituation
object
-
juridicalSituationCode
string
Juridical Situation codeExample:000
-
description
object
-
nl
string
Dutch description of the juridical situationExample:Normale toestand
-
fr
string
French description of the juridical situationExample:Situation normale
-
de
string
German description of the juridical situationExample:Gewöhnlicher Zustand
-
Pagination
object
-
limit
integer
The used pagination limit, by default the maximum limit allowed by your planExample:10
-
page
integer
The current pageExample:1
-
totalPages
integer
The number of pagesExample:99
-
totalItems
integer
The total number of items in the source dataExample:1234
-
countItems
integer
The number of items in the current requestExample:8
Exemple
200
Successful responseAll juridical situations matching your search criteria are returned.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/juridical-situations?query=Stop
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1153 X-API-Request-Limit: X-API-Search-Request-Count: 252 X-API-Search-Request-Limit: X-Parse-Time: 0.03698 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "JuridicalSituations": [ { "JuridicalSituation": { "juridicalSituationCode": "006", "description": { "nl": "Stopzetting wegens vervanging van het ondernemingsnummer", "fr": "Arrêt pour cause de remplacement du numéro d'entreprise", "de": "Beendigung wegen Ersetzung der Unternehmensnummer" } } }, { "JuridicalSituation": { "juridicalSituationCode": "011", "description": { "nl": "Activiteitstopzetting in België (buitenlandse entiteit)", "fr": "Cessation des activités en Belgique (entité étrangère)", "de": "Tätigkeitsbeendung in Belgien (ausländische Einheit)" } } }, { "JuridicalSituation": { "juridicalSituationCode": "015", "description": { "nl": "Stopzetting entiteit zonder rechtspersoonlijkheid", "fr": "Arrêt d’une entité sans personnalité juridique", "de": "Beendigung einer Einheit ohne Rechtspersönlichkeit" } } }, { "JuridicalSituation": { "juridicalSituationCode": "016", "description": { "nl": "Stopzetting activiteit entiteit natuurlijk persoon", "fr": "Cessation d'activité d'une entité personne physique", "de": "Betriebsstillegung einer Einheit natürliche Person" } } }, { "JuridicalSituation": { "juridicalSituationCode": "018", "description": { "nl": "Stopzetting in bekendmaking", "fr": "Arrêt de l’identification", "de": "Beendigung der Identifizierung" } } }, { "JuridicalSituation": { "juridicalSituationCode": "019", "description": { "nl": "Stopzetting van een EDRL of niet-EU entiteit", "fr": "Arrêt d’une entité EDRL ou non UE", "de": "Stillegung einer EU-DLR oder einer nicht-EU Einheit" } } }, { "JuridicalSituation": { "juridicalSituationCode": "111", "description": { "nl": "Doorhaling wegens stopzetting in een EER-register", "fr": "Radiation en raison de l’arrêt dans un registre de l’EEE", "de": "Löschung nach der Stilllegung in einem Register des EWR" } } } ], "Pagination": { "limit": 20, "page": 1, "totalPages": 1, "totalItems": 7, "countItems": 7 } }
402
Larger plan requiredThe endpoint (or a parameter that is present), is only accessible for a specific plan. Please verify the request which plan is required and upgrade accordingly.{ "exception": "PlanScopeException", "error": "Your active plan doesn't meet the requirements for this endpoint", "code": -31 }
/vat/{vatNumber}Verify VAT-number or enterprise number for internation transactions within the EUPlease note: we use an external service for validating VAT-numbers this may not always be available.
Only use this method for validating the VAT-number for international transactions within the EU, not for retrieving company information, you may use the/enterprise
endpoints for that purpose.
Even though the response may say the VAT-number is invalid, it may still be valid for domestic transactions.Arguments et paramètres
-
FieldTypeDescription
-
vatNumber
string
The VAT-number to be validated, a valid Belgian VAT-number starts with BE followed by 10 digits. The field may also contains a valid Enterprise numberExample:BE0417497106
Réponse
Successful response | The VAT-number has been validated. Please note: this does not necessary mean the provided VAT-number is valid, check the `isValid` value of the response.
-
FieldTypeDescription
-
vatNumber
string
The validated VAT-numberExample:BE0417497106
-
isValid
boolean
Boolean if provided VAT-number is validExample:1
-
details
object
-
name
string
Example:NV BELFIUS BANK
-
address
string
Use the enterprise address endpoint instead.Example:Karel Rogierplein 11, 1210 Sint-Joost-ten-Node
-
enterpriseNumber
string
Example:0417497106
-
enterpriseNumberFormatted
string
Example:0417.497.106
Exemple
200
Successful responseThe VAT-number has been validated. Please note: this does not necessary mean the provided VAT-number is valid, check the `isValid` value of the response.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/vat/{vatNumber}
{ "vatNumber": "BE0417497106", "isValid": true, "details": { "name": "NV BELFIUS BANK", "address": "Karel Rogierplein 11, 1210 Sint-Joost-ten-Node" }, "enterpriseNumber": "0417497106", "enterpriseNumberFormatted": "0417.497.106" }
HTTP/1.1 200 OK
404
Item or resource not foundThe item or resource specified could not be found{ "exception": "RequestException", "error": "The item specified could not be found", "code": -2 }
500
Service for VAT-validation is not available./meGet authorized customer informationRéponse
Success response | The provided authorization token is valid.
-
FieldTypeDescription
-
Customer
object
-
username
string
The username of the authorized customerExample:customer@example.com
-
planDescription
string
Active plan nameExample:Small
-
dateCreated
string
The date the customer is createdExample:2020-02-02 02:02:02
-
ApiAccessToken
object
-
isDevelopment
boolean
API-token type -
description
string
The customer defined description of the tokenExample:Development-token
-
dateCreated
string
Example:2020-02-02 02:02:02
-
dateExpiration
string
Example:2021-02-02 02:02:02
Exemple
200
Success responseThe provided authorization token is valid.curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer tk9xkS0PrDpa1yxIT6WWwD204c3pgOe8fIpguPCeGGzZ2ufRU5F74lMW1ap111g7" \ https://api.kbodata.app/v2/v2/me
HTTP/1.1 200 OK Access-Control-Allow-Origin: * X-API-Key-Type: production X-API-Request-Count: 1154 X-API-Request-Limit: X-API-Search-Request-Count: 253 X-API-Search-Request-Limit: X-Parse-Time: 0.02506 Access-Control-Allow-Headers: Authorization, Content-Type, X-Requested-With Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, PATCH, DELETE Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=63072000; includeSubdomains; Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8
{ "Customer": { "username": "user@company.com", "planDescription": "Unlimited", "dateCreated": "2017-05-22 09:22:38" }, "ApiAccessToken": { "isDevelopment": false, "description": "API Docs", "dateCreated": "2020-09-05 22:49:12", "dateExpiration": null } }
401
Invalid authorization token provided{ "exception": "AuthorizationException", "error": "The provided access token is invalid", "code": -2 }
Responses
HTTP status codes
By looking at the HTTP response code, you can see if the request was successful or not. If the request was unsuccessful, you can usually use the HTTP response code and the error message in the JSON-response to find out what went wrong. You probably need change something in the request parameters.
Below is a list of common HTTP response codes, used in our API:
-
200 OK
Success The request was successful and the data can be used. -
401 Unauthorized
Not authorized You will retrieve this status code if the authorization fails, possible by using an incorrect username or access token. -
402 Payment Required
Means that your plan has expired and needs renewal. You can do this on your dashboard. -
404 Not Found
Will be returned if the specific item requested, cannot be found. Also used when an endpoint doesn't exist, but the API-token is valid. -
405 Method Not Allowed
The used request method is unaccepted, in example this will be returned when the requested method isPOST
, but should be aGET
. -
409 Conflict
422 Unprocessable Entity
Incorrect or missing parameters The requested request could not be processed, usually due missing required parameters or parameters that contain an incorrect format. -
429 Too Many Requests
Request limit exceeded You have exceeded the maximum number of requests for this period, wait until for a limit reset at the end of your period or upgrade your subscription plan. You can do this on your dashboard.
Cookies
Nous, ainsi que des partenaires sélectionnés, utilisons des cookies ou des technologies similaires, comme spécifié dans la politique en matière de cookies. Vous pouvez consentir à l'utilisation de ces technologies en fermant le présent avis.