API.DATA.BE
Get company information through our simple REST API.
If you need help on access or authentication please check our Access Guide below.
To understand the different endpoints and implementations, please click on any of our API sections on the left of your screen.
Access and Authentication
We validate all API key requests. After confirmation, you will receive an email with instructions on how to proceed.
To use the API, you must send valid API_ID and API_KEY parameters via headers for each call.
Credits and Limits
We send in every response the following headers allowing you to monitor your credits and limits
Name | Type | Description |
---|---|---|
X-Credit-Remaining | integer | The number of remaining credits |
X-Rate-Limit-Limit | integer | The limit of calls per period |
X-Rate-Limit-Period | string | The limit period |
X-Rate-Limit-Remaining | integer | The remaining number of calls during the current period |
Advanced Company Information
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
input | string | The VAT number requested (vat_number) |
active | boolean | true if the VAT number is an active company, false otherwise |
valid | boolean | true if the VAT number is a valid VAT number, false if the VAT number is not a valid VAT number |
company_name | string | The official company name |
start_date | date | The constitution date of company |
language | string | Company language as 2-letter code (en, nl, fr, de) |
addresses | object | Company full address including municipality, street, box, country_code, zip_code, house_number, type, full_address |
activities | string | All sectors in which company is active according to NACE codes |
company_names | string | All company names of the company |
vat_clean | string | The numeric part of the VAT number requested (digits only) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
phone_number | string | The official phone number of the company |
fax_number | string | The official fax number of the company |
string | The email address of the company | |
website | string | The website |
establishment_units | integer | The number of establishments |
juridical_form | object | The form code of the company |
juridical_situation | object | The official juridical situation code of the company |
legal_representative_persons | object | Please read documentation of API Legal representatives |
legal_representative_companies | object | Please read documentation of API Legal representatives |
statements | object | Please read documentation of API Financial Statements |
financial_meta | object | Financial information related to company constitution |
Method URL
https://api.data.be/2.0/companies/{vat_number}/info
Example
https://api.data.be/2.0/companies/BE0844044609/info
These requests will return:
{
"active": true,
"input": "BE0844044609",
"valid": true,
"identifier": "BE0844044609",
"language": null,
"addresses": [
{
"municipality": "Etterbeek",
"street": "Rue des Pères Blancs",
"box": null,
"type": {
"code": "HEAD",
"schema": "https://api.data.be/2.0/references/type_of_address_codes/BE_ADDRESS",
"start_date": "2012-02-29",
"end_date": null
},
"country_code": "BE",
"zip_code": "1040",
"house_number": "4",
"full_address": "Rue des Pères Blancs 4, 1040 Etterbeek, Belgique"
}
],
"type": {
"code": "2",
"schema": "https://api.data.be/2.0/references/type_codes/BE_TYPE",
"start_date": null,
"end_date": null
},
"activities": [
{
"code": "46510",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "70210",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "62090",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "62020",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "MAIN",
"start_date": "2013-05-15",
"end_date": null
},
{
"code": "62010",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "MAIN",
"start_date": "2017-06-07",
"end_date": null
}
],
"company_names": [
{
"code": "002",
"schema": "https://api.data.be/2.0/references/name_codes/BE_COMPANYNAME",
"language": "fr",
"value": "DATA",
"start_date": "2012-02-29",
"end_date": null
},
{
"code": "001",
"schema": "https://api.data.be/2.0/references/name_codes/BE_COMPANYNAME",
"language": "fr",
"value": "Data.be",
"start_date": "2012-02-29",
"end_date": null
}
],
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"company_name": "Data.be",
"start_date": "2012-02-29",
"phone_number": null,
"fax_number": null,
"email": null,
"website": null,
"establishment_units": 1,
"juridical_form": {
"code": "015",
"schema": "https://api.data.be/2.0/references/juridical_form_codes/BE_FORM",
"start_date": "2012-02-29",
"end_date": null
},
"juridical_situation": {
"code": "000",
"schema": "https://api.data.be/2.0/references/juridical_situation_codes/BE_SITUATION",
"start_date": "2012-02-29",
"end_date": null
},
"data_urls": [],
"legal_representative_persons": {
"total": 2,
"uri": "https://api.data.be/2.0/companies/BE0844044609/legal_representative_persons"
},
"legal_representative_companies": {
"total": 2,
"uri": "https://api.data.be/2.0/companies/BE0844044609/legal_representative_companies"
},
"statements": {
"total": 4,
"uri": "https://api.data.be/2.0/companies/BE0844044609/statements"
},
"financial_meta": {
"capital": 20000,
"exceptional_fiscal_year_begin": "2012-02-29",
"exceptional_fiscal_year_end": "2012-12-31",
"annual_meeting_month": "6",
"fiscal_year_end_day": "31",
"fiscal_year_end_month": "12"
}
}
Financial Statements
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
total | integer | The amount of Annual Reports the API has fetched (generally, one for each year) |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
uri | link | Link to the official document |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
identifier | string | identifier |
year | integer | Year of the report |
employees | integer | Number of employees in the firm in that year |
turnover | double | The turnover of the company in that year |
equity | double | The amount of equity on the company's balance sheet |
revisors | object | Personal name, address, company name of the accountant of the company |
account_date | date | The date of the Annual Report, formatted as YYYY-MM-DD |
current_assets | double | Number of current assets on the balance sheet |
gross_operating_margin | double | The gross operating margin |
tangible_fixed_assets | double | The amount of tangible fixed assets on the balance sheet |
gain_loss_period | double | The amount of loss or profit the company has made that year according to the income statement |
current_ratio | double | Returns the Current Ratio, which is a ratio of Current Assets on Current Liabilities. Financial analists use this ratio to assess the liquidity of the company. |
net_cash | double | The amount of cash on the balance sheet, in EUR |
self_financing_degree | double | An indicator as a percentage of both the historical profitability of a company and its dividend and reserve policy |
return_on_equity | double | The return the company has made in that year relative to equity (in percentages). This is computed by dividing Net Income by the Book Value of equity. |
added_value | double | The added value is a relevant indicator of the overall performance of a company. Macroeconomically, it is equal to the difference between the production value and the consumption of goods and services. |
Method URL
https://api.data.be/2.0/companies/{vat_number}/statements
Example
https://api.data.be/2.0/companies/BE0844044609/statements
These requests will return:
{
"total": 4,
"vat_valid": true,
"list": [
{
"uri": "https://api.data.be/2.0/BE0844044609/statements/xbrl_0844044609-2016-64900505",
"identifier": "xbrl_0844044609-2016-64900505",
"year": 2015,
"employees": 1,
"turnover": null,
"equity": 58527,
"revisors": [
{
"type": "ParticipantRepresentative",
"company_name": "Cobofisca SPRL",
"last_name": "Trog",
"first_name": "Peter",
"profession": "Comptable",
"id_number": "30127085",
"address": {
"municipality": "Erpe",
"street": "Kleine Steenweg",
"box": null,
"country_code": "BE",
"zip_code": "9420",
"house_number": "2",
"full_address": "Kleine Steenweg 2 , 9420 Erpe, België"
},
"mandate_code": null,
"mandate_start_date": null,
"mandate_end_date": null,
"schema": "https://api.data.be/2.0/references/mandate_codes/BE_MANDATE"
}
],
"account_date": "2015-12-31",
"current_assets": 148666,
"gross_operating_margin": 95299,
"tangible_fixed_assets": 1028,
"gain_loss_period": 30457,
"current_ratio": null,
"net_cash": null,
"self_financing_degree": 25.65,
"return_on_equity": 52.04,
"added_value": null
},
{
"uri": "https://api.data.be/2.0/BE0844044609/statements/xbrl_0844044609-2015-61200122",
"identifier": "xbrl_0844044609-2015-61200122",
"year": 2014,
"employees": null,
"turnover": null,
"equity": 28071,
"revisors": [
{
"type": "ParticipantRepresentative",
"company_name": "Cobofisca",
"last_name": "Trog",
"first_name": "Peter",
"profession": null,
"id_number": "30127085",
"address": {
"municipality": null,
"street": "Kleine Steenweg",
"box": null,
"country_code": "BE",
"zip_code": "9420",
"house_number": "2",
"full_address": "Kleine Steenweg 2 , 9420 , België"
},
"mandate_code": null,
"mandate_start_date": null,
"mandate_end_date": null,
"schema": "https://api.data.be/2.0/references/mandate_codes/BE_MANDATE"
}
],
"account_date": "2014-12-31",
"current_assets": 99560,
"gross_operating_margin": 79382,
"tangible_fixed_assets": 2279,
"gain_loss_period": 33501,
"current_ratio": null,
"net_cash": null,
"self_financing_degree": 7.93,
"return_on_equity": 119.34,
"added_value": null
},
{
"uri": "https://api.data.be/2.0/BE0844044609/statements/xbrl_0844044609-2014-60300330",
"identifier": "xbrl_0844044609-2014-60300330",
"year": 2013,
"employees": 1,
"turnover": null,
"equity": -5430,
"revisors": [],
"account_date": "2013-12-31",
"current_assets": 29932,
"gross_operating_margin": 20280,
"tangible_fixed_assets": 2301,
"gain_loss_period": -9556,
"current_ratio": null,
"net_cash": null,
"self_financing_degree": null,
"return_on_equity": 175.99,
"added_value": null
},
{
"uri": "https://api.data.be/2.0/BE0844044609/statements/xbrl_0844044609-2013-62600319",
"identifier": "xbrl_0844044609-2013-62600319",
"year": 2012,
"employees": null,
"turnover": null,
"equity": 4126,
"revisors": [],
"account_date": "2012-12-31",
"current_assets": 6137,
"gross_operating_margin": -14268,
"tangible_fixed_assets": null,
"gain_loss_period": -15874,
"current_ratio": null,
"net_cash": null,
"self_financing_degree": null,
"return_on_equity": -384.73,
"added_value": null
}
],
"vat_input": "BE0844044609",
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609"
}
Legal Representatives
Legal Representative Persons
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
total | integer | The amount of legal representative persons |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
schema | uri | Link to the list of role codes |
full_name | string | Full name of the legal representative |
last_name | string | Last name of the legal representative |
first_name | string | First name of the legal representative |
role_code | string | The role code |
company_id | string | The company identifier (VAT number) |
role_start_date | date | The start date of the role |
role_end_date | date | The end date of the role |
Legal Representative Companies
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
total | integer | The amount of legal representative companies |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
name | string | Name of the company |
schema | uri | Link to the list of role codes |
role_start_date | date | The start date of the role |
role_code | string | The role code |
company_id | string | The company identifier (VAT number) |
formatted_vat | string | The formatted VAT number of the legal representative as BE 0###.###.### |
vat_input | string | The VAT number requested |
vat_clean | string | The numeric part of the VAT number requested (only digits) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
Method URL
https://api.data.be/2.0/companies/{vat_number}/legal_representative_persons
Example
https://api.data.be/2.0/companies/BE0844044609/legal_representative_persons
These requests will return:
{
"total": 2,
"vat_valid": true,
"list": [
{
"schema": "https://api.data.be/2.0/references/role_codes/BE_ROLE",
"full_name": "Toon, Vanagt",
"last_name": "Vanagt",
"first_name": "Toon",
"role_code": "10003",
"company_id": "BE0478156352",
"formatted_vat": "BE 0478.156.352",
"role_start_date": "2012-02-29",
"role_end_date": null
},
{
"schema": "https://api.data.be/2.0/references/role_codes/BE_ROLE",
"full_name": "Eric, Rodriguez",
"last_name": "Rodriguez",
"first_name": "Eric",
"role_code": "10003",
"company_id": "BE0835188905",
"formatted_vat": "BE 0835.188.905",
"role_start_date": "2012-02-29",
"role_end_date": null
}
],
"vat_input": "BE0844044609",
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609"
}
Method URL
https://api.data.be/2.0/companies/{vat_number}/legal_representative_companies
Example
https://api.data.be/2.0/companies/BE0844044609/legal_representative_companies
These requests will return:
{
"total": 2,
"vat_valid": true,
"list": [
{
"name": null,
"schema": "https://api.data.be/2.0/references/role_codes/BE_ROLE",
"role_start_date": "2012-02-29",
"role_code": "10006",
"company_id": "BE0478156352",
"formatted_vat": "BE 0478.156.352"
},
{
"name": null,
"schema": "https://api.data.be/2.0/references/role_codes/BE_ROLE",
"role_start_date": "2012-02-29",
"role_code": "10006",
"company_id": "BE0835188905",
"formatted_vat": "BE 0835.188.905"
}
],
"vat_input": "BE0844044609",
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609"
}
Bank Accounts
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
iban_number | string | The bank account number in IBAN format |
Response
Name | Type | Description |
---|---|---|
vat_input | string | The VAT number requested |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
vat_clean | string | The numeric part of the VAT number requested (only digits) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
iban_input | string | The bank account number requested |
iban_valid | boolean | True if the bank account number is a valid bank account number, false otherwise |
iban_clean | string | The bank account number in IBAN format |
iban_formatted | string | The formatted IBAN number as BE## #### #### #### |
iban_known | boolean | True if we have the IBAN number, false otherwise |
bic | string | The bic number for the bank |
iban_start_date | date | The date the bank account started, formatted as YYYY-MM-DD |
Method URL
https://api.data.be/2.0/companies/{vat_number}/bank_accounts/{iban_number}
Example
https://api.data.be/2.0/companies/BE0844044609/bank_accounts/BE49735030379071
These requests will return:
{
"vat_input": "BE0844044609",
"vat_valid": true,
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"iban_input": "BE49735030379071",
"iban_valid": true,
"iban_clean": "BE49735030379071",
"iban_formatted": "BE49 7350 3037 9071",
"iban_known": true,
"bic": "KREDBEBB",
"iban_start_date": "2012-02-29"
}
Bank Accounts By Vat
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
total | integer | The amount of bank accounts the API has fetched |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
iban_valid | boolean | True if the bank account number is a valid bank account number, false otherwise |
iban_clean | string | The bank account number in IBAN format |
iban_formatted | string | The formatted IBAN number as BE## #### #### #### |
iban_known | boolean | True if we have the IBAN number, false otherwise |
bic | string | The bic number for the bank |
iban_start_date | date | The date the bank account started, formatted as YYYY-MM-DD |
vat_input | string | The VAT number requested |
vat_clean | string | The numeric part of the VAT number requested (only digits) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
Method URL
https://api.data.be/2.0/companies/{vat_number}/bank_accounts
Example
https://api.data.be/2.0/companies/BE0844044609/bank_accounts
These requests will return:
{
"total": 1,
"vat_valid": true,
"list": [
{
"vat_input": "0844044609",
"vat_valid": true,
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"iban_input": null,
"iban_valid": true,
"iban_clean": "BE08735028530213",
"iban_formatted": "BE08 7350 2853 0213",
"iban_known": true,
"bic": "KREDBEBB",
"iban_start_date": "2012-02-29"
}
],
"vat_input": "0844044609",
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609"
}
Bank Accounts By Iban
Parameters
Name | Type | Description |
---|---|---|
iban_number | string | The bank account number in IBAN format |
Response
Name | Type | Description |
---|---|---|
vat_input | string | Null as no vat is provided |
vat_valid | boolean | True if the fetched VAT number is a valid Belgian VAT number, false otherwise |
vat_clean | string | The numeric part of the fetched VAT number (only digits) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
iban_input | string | The bank account number requested |
iban_valid | boolean | True if the bank account number is a valid bank account number, false otherwise |
iban_clean | string | The bank account number in IBAN format |
iban_formatted | string | The formatted IBAN number as BE## #### #### #### |
iban_known | boolean | True if we have the IBAN number, false otherwise |
bic | string | The bic number for the bank |
iban_start_date | date | The date the bank account started, formatted as YYYY-MM-DD |
Method URL
https://api.data.be/2.0/companies/bank_accounts/{iban_number}
Example
https://api.data.be/2.0/companies/bank_accounts/BE49735030379071
These requests will return:
{
"vat_input": null,
"vat_valid": true,
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"iban_input": "BE49735030379071",
"iban_valid": true,
"iban_clean": "BE49735030379071",
"iban_formatted": "BE49 7350 3037 9071",
"iban_known": true,
"bic": "KREDBEBB",
"iban_start_date": "2012-02-29"
}
Stakeholders
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to retrieve information from. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
total | integer | The amount of stake holders mentioned in the Annual Reports |
vat_valid | boolean | true if the VAT number is a valid Belgian VAT number, false otherwise |
type | string | Type of stakeholder |
company_name | string | Company name of the stakeholder |
last_name | string | Last name of the stakeholder |
first_name | string | First name of the stakeholder |
profession | string | Profession of the stakeholder |
id_number | string | The official number of the stakeholder. e.g. auditor registration number |
address | object | The address of the stakeholder |
mandate_code | string | The code of the mandate the stakeholder has in the company |
mandate_start_date | date | The start date of the mandate |
mandate_end_date | date | The end date of the mandate |
schema | uri | Link to the list of mandate codes |
source_date | date | Date of the extracted information source |
Method URL
https://api.data.be/2.0/companies/{vat_number}/stakeholders
Example
https://api.data.be/2.0/companies/BE0844044609/stakeholders
These requests will return:
{
"total": 2,
"vat_valid": true,
"list": [
{
"type": "AdministratorEntity-ParticipantRepresentative",
"company_name": "VIRTUALISERS SPRL",
"last_name": "Vanagt",
"first_name": "Toon",
"profession": null,
"id_number": null,
"address": {
"municipality": null,
"street": "Anneessensstraat",
"box": null,
"country_code": "BE",
"zip_code": "1000",
"house_number": "22",
"full_address": "Anneessensstraat 22 , 1000 , Belgique"
},
"mandate_code": null,
"mandate_start_date": null,
"mandate_end_date": null,
"schema": "https://api.data.be/2.0/references/mandate_codes/BE_MANDATE",
"source_date": "2015-12-31"
},
{
"type": "AdministratorEntity-ParticipantRepresentative",
"company_name": "Lambda Mind SPRL",
"last_name": "Rodriquez",
"first_name": "Eric",
"profession": null,
"id_number": null,
"address": {
"municipality": null,
"street": "Rue Baron de Castro",
"box": null,
"country_code": "BE",
"zip_code": "1040",
"house_number": "82",
"full_address": "Rue Baron de Castro 82 , 1040 , Belgique"
},
"mandate_code": null,
"mandate_start_date": null,
"mandate_end_date": null,
"schema": "https://api.data.be/2.0/references/mandate_codes/BE_MANDATE",
"source_date": "2015-12-31"
}
],
"vat_input": "BE0844044609",
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609"
}
European VAT Check
Parameters
Name | Type | Description |
---|---|---|
vat_number | string | The European VAT number to validate. The service will try to clean user input as much as possible to ensure validation against bad formatted VAT numbers. The input should at least contain the European country code (2-letters ISO 3166-1) and the country specific significant digits of the VAT number. |
Response
Name | Type | Description |
---|---|---|
countryCode | string | The country code of the VAT number requested |
vatNumber | string | The numeric part of the VAT number requested |
requestDate | date | The request date |
valid | boolean | true if the VAT number is a valid European VAT number, false otherwise |
name | string | The company name |
address | string | The company full address |
Method URL
https://api.data.be/2.0/companies/{vat_number}/vies
Example
https://api.data.be/2.0/companies/BE0844044609/vies
These requests will return:
{
"country_code": "BE",
"vat_number": "0844044609",
"request_date": "2018-08-23",
"valid": true,
"name": "SPRL DATA.BE",
"address": "RUE DES PÈRES BLANCS 4\n1040 ETTERBEEK"
}
Company guess
Parameters
Name | Type | Description |
---|---|---|
company_name | string | Search query in companies name |
identifier | string | Search query in companies identifier |
active | boolean | whether to search only in active companies or not. |
Response
Name | Type | Description |
---|---|---|
active | boolean | True if the VAT number is an active company, false otherwise |
identifier | string | identifier |
language | string | Company language as 2-letter code (en, nl, fr, de) |
company_name | string | The official company name |
main_address | object | Company main address including municipality, street, box, Country_code, zip_code, house_number, full_address |
start_date | date | The constitution date of company |
main_activity | object | Main sector in which company is active |
vat_clean | string | The numeric part of the VAT number requested (digits only) |
vat_formatted | string | The formatted VAT number as BE 0###.###.### |
type | string | Entity type |
juridical_form | object | The form code of the company |
juridical_situation | object | The official juridical situation code of the company |
uri | string | The uri to the advanced company information |
Method URL
POST https://api.data.be/2.0/companies/guess
Example
POST https://api.data.be/2.0/companies/guess
{
"active": "true",
"company_name": "data",
"identifier": "0844044609"
}
These requests will return:
{
"total": 3,
"companies": [
{
"active": true,
"identifier": "BE0844044609",
"language": null,
"company_name": "Data.be",
"main_address": {
"municipality": "Etterbeek",
"street": "Rue des Pères Blancs",
"box": null,
"country_code": "BE",
"zip_code": "1040",
"house_number": "4",
"full_address": "Rue des Pères Blancs 4, 1040 Etterbeek, Belgique"
},
"start_date": "2012-02-29",
"main_activity": {
"code": "62010",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "MAIN",
"start_date": "2017-06-07",
"end_date": null
},
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"type": {
"code": "2",
"schema": "https://api.data.be/2.0/references/type_codes/BE_TYPE",
"start_date": null,
"end_date": null
},
"juridical_form": {
"code": "015",
"schema": "https://api.data.be/2.0/references/juridical_form_codes/BE_FORM",
"start_date": "2012-02-29",
"end_date": null
},
"juridical_situation": {
"code": "000",
"schema": "https://api.data.be/2.0/references/juridical_situation_codes/BE_SITUATION",
"schematart_date": "2012-02-29",
"end_date": null
},
"uri": "https://api.data.be/2.0/companies/BE0844044609/info"
},
{...},
{...}
]
}
Company search
Warning: each company returned in the search result counts as one API credit.
For example if the response contains 7 matching companies, you will consume 7 API credits in one call.
To know the cost beforehand you can make a call with the "max" parameter set to 0 and get only the total number of results
Parameters
Name | Type | Description |
---|---|---|
q | string | Search query |
active | boolean | whether to search only in active companies or not. |
range_filters | object |
range filters with the following structure :
{ "filter_name": {"from": "from_value", "to": "to_value"} } The possible filters are : "start_date", "end_date" et "zip_code" |
term_filters | object |
term filters with the following structure :
{ "filter_name": ["value 1", "value 2", "value 3"] } The possible filters are : "activity", "juridical_form", "zip_code" et "legal_person_type" |
has_phone | boolean | whether at least one phone number is required. |
has_email | boolean | whether at least one email address is required. |
has_website | boolean | whether at least one website is required. |
page | integer | The number of the page results to return (offset 1). |
max | integer | The maximum number of results per page (default 10) |
Response
Name | Type | Description |
---|---|---|
total | integer | The total number of results |
companies | array | List of company objects as returned by the Advanced Company Information endpoint |
Method URL
POST https://api.data.be/2.0/companies/search
Example
POST https://api.data.be/2.0/companies/search
{
"q": "",
"active": "true",
"range_filters": {
"start_date": {
"from": "20150101",
"to": "20190101"
},
"zip_code": {
"from": "1000",
"to": "1299"
}
},
"term_filters": {
"activity": [
"46510",
"62090",
"62020"
],
"juridical_form": [
"015"
],
"zip_code": [
"1040",
"1050",
"2000"
],
"legal_person_type": [
"2"
]
},
"has_phone": "true",
"has_email": "true",
"has_website": "true",
"page": "1",
"max": "10",
"sort": [
{
"start_date": "desc"
},
{
"company_name": "asc"
}
]
}
These requests will return:
{
"total": 3,
"companies": [
{
"active": true,
"input": "BE0844044609",
"valid": true,
"identifier": "BE0844044609",
"language": null,
"addresses": [
{
"municipality": "Etterbeek",
"street": "Rue des Pères Blancs",
"box": null,
"country_code": "BE",
"zip_code": "1040",
"house_number": "4",
"full_address": "Rue des Pères Blancs 4, 1040 Etterbeek, Belgique"
}
],
"type": {
"code": "2",
"schema": "https://api.data.be/2.0/references/type_codes/BE_TYPE",
"start_date": null,
"end_date": null
},
"activities": [
{
"code": "46510",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "70210",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "62090",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "SECO",
"start_date": "2012-03-01",
"end_date": null
},
{
"code": "62020",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "MAIN",
"start_date": "2013-05-15",
"end_date": null
},
{
"code": "62010",
"schema": "https://api.data.be/2.0/references/activity_codes/NACE_2008",
"classification": "MAIN",
"start_date": "2017-06-07",
"end_date": null
}
],
"company_names": [
{
"code": "002",
"schema": "https://api.data.be/2.0/references/name_codes/BE_COMPANYNAME",
"language": "fr",
"value": "DATA",
"start_date": "2012-02-29",
"end_date": null
},
{
"code": "001",
"schema": "https://api.data.be/2.0/references/name_codes/BE_COMPANYNAME",
"language": "fr",
"value": "Data.be",
"start_date": "2012-02-29",
"end_date": null
}
],
"vat_clean": "0844044609",
"vat_formatted": "BE 0844.044.609",
"company_name": "Data.be",
"start_date": "2012-02-29",
"phone_number": null,
"fax_number": null,
"email": null,
"website": null,
"establishment_units": 1,
"juridical_form": {
"code": "015",
"schema": "https://api.data.be/2.0/references/juridical_form_codes/BE_FORM",
"start_date": "2012-02-29",
"end_date": null
},
"juridical_situation": {
"code": "000",
"schema": "https://api.data.be/2.0/references/juridical_situation_codes/BE_SITUATION",
"start_date": "2012-02-29",
"end_date": null
},
"data_urls": [],
"legal_representative_persons": {
"total": 2,
"uri": "https://api.data.be/2.0/companies/BE0844044609/legal_representative_persons"
},
"legal_representative_companies": {
"total": 2,
"uri": "https://api.data.be/2.0/companies/BE0844044609/legal_representative_companies"
},
"statements": {
"total": 4,
"uri": "https://api.data.be/2.0/companies/BE0844044609/statements"
},
"financial_meta": {
"capital": 20000,
"exceptional_fiscal_year_begin": "2012-02-29",
"exceptional_fiscal_year_end": "2012-12-31",
"annual_meeting_month": "6",
"fiscal_year_end_day": "31",
"fiscal_year_end_month": "12"
}
},
{...},
{...}
]
}