B2B API — Search Companies
Use this endpoint to search for companies and return a list of matching results.
Related Restful B2B API documentation:
Company name only
Search for companies using their registered company name.
lookupcname
Request
Both GET and POST are supported.
{SERVER_ADDRESS}, {VERSION}
and {LICENCE_CODE} are provided by DQE upon
account creation. Contact your DQE account manager to obtain
these credentials.
GEThttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Simply replace the items in braces with your information.
Code examples
Search for "dqe paris" in France
curl "https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence={LICENCE_CODE}&Filter=1"
fetch("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?"
+ new URLSearchParams({
CompanyName: "dqe paris",
Country: "FRA",
Licence: "{LICENCE_CODE}",
Filter: "1"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcname/",
params={
"CompanyName": "dqe paris",
"Country": "FRA",
"Licence": "{LICENCE_CODE}",
"Filter": "1",
},
)
print(response.json())
<?php
$params = http_build_query([
'CompanyName' => 'dqe paris',
'Country' => 'FRA',
'Licence' => '{LICENCE_CODE}',
'Filter' => '1',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/{VERSION}/lookupcname/',
{
params: {
CompanyName: 'dqe paris',
Country: 'FRA',
Licence: '{LICENCE_CODE}',
Filter: '1'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/{VERSION}/lookupcname/"
+ "?CompanyName=dqe%20paris&Country=FRA&Licence={LICENCE_CODE}&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/{VERSION}/lookupcname/"
+
"?CompanyName=dqe%20paris&Country=FRA&Licence={LICENCE_CODE}&Filter=1";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/{VERSION}/lookupcname/"
+
"?CompanyName=dqe%20paris&Country=FRA&Licence={LICENCE_CODE}&Filter=1"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/
Add the parameters below in the body using
x-www-form-urlencoded.
Code examples
Search for "dqe paris" in France
curl -X POST "https://{SERVER_ADDRESS}/{VERSION}/lookupcname/"
\
-H "Content-Type: application/x-www-form-urlencoded"
\
-d "Licence={LICENCE_CODE}" \
-d "CompanyName=dqe paris" \
-d "Country=FRA" \
-d "Filter=1"
fetch("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/",
{
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded"
},
body: new URLSearchParams({
Licence: "{LICENCE_CODE}",
CompanyName: "dqe paris",
Country: "FRA",
Filter: "1"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcname/",
data={
"Licence": "{LICENCE_CODE}",
"CompanyName": "dqe paris",
"Country": "FRA",
"Filter": "1",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Licence' => '{LICENCE_CODE}',
'CompanyName' => 'dqe paris',
'Country' => 'FRA',
'Filter' => '1',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/{VERSION}/lookupcname/',
qs.stringify({
Licence: '{LICENCE_CODE}',
CompanyName: 'dqe paris',
Country: 'FRA',
Filter: '1'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Licence={LICENCE_CODE}&CompanyName=dqe%20paris&Country=FRA&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string>
{
["Licence"] = "{LICENCE_CODE}",
["CompanyName"] = "dqe paris",
["Country"] = "FRA",
["Filter"] = "1"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcname/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Licence", "{LICENCE_CODE}")
form.Set("CompanyName", "dqe paris")
form.Set("Country", "FRA")
form.Set("Filter", "1")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/{VERSION}/lookupcname/",
form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameters
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Address of the DQE server that will process the data. | Mandatory |
| VERSION |
Version of the API. Example: v1
|
Mandatory |
| Licence | Number assigned to you as your licence code. | Mandatory |
| CompanyName | User input: company name. | Mandatory |
| Country | ISO 3-letter country code. | Mandatory |
| Filter |
Company status filter. Several values can be separated
by commas. 1 — Opened diffusible 2 — Closed diffusible 3 — Closed old (+3 years) diffusible 4 — Non-diffusible 5 — RNA Example: Filter=1,2
Optional. Default value:
1
|
Optional |
| NAF25 |
Get the new value of Sic Code in France or not: True
/ False
Optional. Default value:
False
|
Optional |
Test the API
Click the button below to test this endpoint live in your browser.
Open console
Company number only
Search for companies using their company number.
lookupcnum
Request
Both GET and POST are supported.
{SERVER_ADDRESS}, {VERSION}
and {LICENCE_CODE} are provided by DQE upon
account creation. Contact your DQE account manager to obtain
these credentials.
GEThttps://{SERVER_ADDRESS}/{VERSION}/lookupcnum/?CompanyNumber={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Simply replace the items in braces with your information.
Code examples
Search by company number in France
curl "https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/?CompanyNumber=504xxxxxx&Country=FRA&Licence={LICENCE_CODE}&Filter=1"
fetch("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/?"
+ new URLSearchParams({
CompanyNumber: "504xxxxxx",
Country: "FRA",
Licence: "{LICENCE_CODE}",
Filter: "1"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/",
params={
"CompanyNumber": "504xxxxxx",
"Country": "FRA",
"Licence": "{LICENCE_CODE}",
"Filter": "1",
},
)
print(response.json())
<?php
$params = http_build_query([
'CompanyNumber' => '504xxxxxx',
'Country' => 'FRA',
'Licence' => '{LICENCE_CODE}',
'Filter' => '1',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/',
{
params: {
CompanyNumber: '504xxxxxx',
Country: 'FRA',
Licence: '{LICENCE_CODE}',
Filter: '1'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/"
+ "?CompanyNumber=504xxxxxx&Country=FRA&Licence={LICENCE_CODE}&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/"
+
"?CompanyNumber=504xxxxxx&Country=FRA&Licence={LICENCE_CODE}&Filter=1";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/"
+
"?CompanyNumber=504xxxxxx&Country=FRA&Licence={LICENCE_CODE}&Filter=1"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/{VERSION}/lookupcnum/
Add the parameters below in the body using
x-www-form-urlencoded.
Code examples
Search by company number in France
curl -X POST "https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/"
\
-H "Content-Type: application/x-www-form-urlencoded"
\
-d "Licence={LICENCE_CODE}" \
-d "CompanyNumber=504xxxxxx" \
-d "Country=FRA" \
-d "Filter=1"
fetch("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/",
{
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded"
},
body: new URLSearchParams({
Licence: "{LICENCE_CODE}",
CompanyNumber: "504xxxxxx",
Country: "FRA",
Filter: "1"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/",
data={
"Licence": "{LICENCE_CODE}",
"CompanyNumber": "504xxxxxx",
"Country": "FRA",
"Filter": "1",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Licence' => '{LICENCE_CODE}',
'CompanyNumber' => '504xxxxxx',
'Country' => 'FRA',
'Filter' => '1',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/',
qs.stringify({
Licence: '{LICENCE_CODE}',
CompanyNumber: '504xxxxxx',
Country: 'FRA',
Filter: '1'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Licence={LICENCE_CODE}&CompanyNumber=504xxxxxx&Country=FRA&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string>
{
["Licence"] = "{LICENCE_CODE}",
["CompanyNumber"] = "504xxxxxx",
["Country"] = "FRA",
["Filter"] = "1"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Licence", "{LICENCE_CODE}")
form.Set("CompanyNumber", "504xxxxxx")
form.Set("Country", "FRA")
form.Set("Filter", "1")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/{VERSION}/lookupcnum/",
form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameters
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Address of the DQE server that will process the data. | Mandatory |
| VERSION |
Version of the API. Example: v1
|
Mandatory |
| Licence | Number assigned to you as your licence code. | Mandatory |
| CompanyNumber | User input: company number. | Mandatory |
| Country | ISO 3-letter country code. | Mandatory |
| Filter |
Company status filter. Several values can be separated
by commas. 1 — Opened diffusible 2 — Closed diffusible 3 — Closed old (+3 years) diffusible 4 — Non-diffusible 5 — RNA Example: Filter=1,2
Optional. Default value:
1
|
Optional |
| NAF25 |
Get the new value of Sic Code in France or not: True
/ False
Optional. Default value:
False
|
Optional |
Test the API
Click the button below to test this endpoint live in your browser.
Open console
Company Name and Postal Code
Search for companies using their name together with a postal code, for a more precise match.
checkcname
Request
Both GET and POST are supported.
{SERVER_ADDRESS} and {LICENCE_CODE}
are provided by DQE upon account creation. Contact your DQE account
manager to obtain these credentials.
Version-specific: this operation is only available
on API version
v1 — it is not available on
v2. Use v1 in the URL for this operation
specifically, even though other B2B Restful operations support
both versions.
GEThttps://{SERVER_ADDRESS}/v1/checkcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Simply replace the items in braces with your information.
Code examples
Search for "dqe paris" near postal code 75017
curl "https://{SERVER_ADDRESS}/v1/checkcname/?CompanyName=dqe%20paris&Country=FRA&PostalCode=75017&Licence={LICENCE_CODE}&Filter=1"
fetch("https://{SERVER_ADDRESS}/v1/checkcname/?"
+ new URLSearchParams({
CompanyName: "dqe paris",
Country: "FRA",
PostalCode: "75017",
Licence: "{LICENCE_CODE}",
Filter: "1"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/v1/checkcname/",
params={
"CompanyName": "dqe paris",
"Country": "FRA",
"PostalCode": "75017",
"Licence": "{LICENCE_CODE}",
"Filter": "1",
},
)
print(response.json())
<?php
$params = http_build_query([
'CompanyName' => 'dqe paris',
'Country' => 'FRA',
'PostalCode' => '75017',
'Licence' => '{LICENCE_CODE}',
'Filter' => '1',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/v1/checkcname/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/v1/checkcname/',
{
params: {
CompanyName: 'dqe paris',
Country: 'FRA',
PostalCode: '75017',
Licence: '{LICENCE_CODE}',
Filter: '1'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/v1/checkcname/"
+ "?CompanyName=dqe%20paris&Country=FRA&PostalCode=75017&Licence={LICENCE_CODE}&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/v1/checkcname/"
+
"?CompanyName=dqe%20paris&Country=FRA&PostalCode=75017&Licence={LICENCE_CODE}&Filter=1";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/v1/checkcname/"
+
"?CompanyName=dqe%20paris&Country=FRA&PostalCode=75017&Licence={LICENCE_CODE}&Filter=1"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/v1/checkcname/
Add the parameters below in the body using
x-www-form-urlencoded.
Code examples
Search for "dqe paris" near postal code 75017
curl -X POST "https://{SERVER_ADDRESS}/v1/checkcname/"
\
-H "Content-Type: application/x-www-form-urlencoded"
\
-d "Licence={LICENCE_CODE}" \
-d "CompanyName=dqe paris" \
-d "PostalCode=75017" \
-d "Country=FRA" \
-d "Filter=1"
fetch("https://{SERVER_ADDRESS}/v1/checkcname/",
{
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded"
},
body: new URLSearchParams({
Licence: "{LICENCE_CODE}",
CompanyName: "dqe paris",
PostalCode: "75017",
Country: "FRA",
Filter: "1"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/v1/checkcname/",
data={
"Licence": "{LICENCE_CODE}",
"CompanyName": "dqe paris",
"PostalCode": "75017",
"Country": "FRA",
"Filter": "1",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/v1/checkcname/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Licence' => '{LICENCE_CODE}',
'CompanyName' => 'dqe paris',
'PostalCode' => '75017',
'Country' => 'FRA',
'Filter' => '1',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/v1/checkcname/',
qs.stringify({
Licence: '{LICENCE_CODE}',
CompanyName: 'dqe paris',
PostalCode: '75017',
Country: 'FRA',
Filter: '1'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Licence={LICENCE_CODE}&CompanyName=dqe%20paris&PostalCode=75017&Country=FRA&Filter=1";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/v1/checkcname/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string>
{
["Licence"] = "{LICENCE_CODE}",
["CompanyName"] = "dqe paris",
["PostalCode"] = "75017",
["Country"] = "FRA",
["Filter"] = "1"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/v1/checkcname/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Licence", "{LICENCE_CODE}")
form.Set("CompanyName", "dqe paris")
form.Set("PostalCode", "75017")
form.Set("Country", "FRA")
form.Set("Filter", "1")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/v1/checkcname/",
form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameters
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Address of the DQE server that will process the data. | Mandatory |
| VERSION |
Fixed to v1 for this operation — not
configurable, v2 does not support it.
|
Mandatory |
| Licence | Number assigned to you as your licence code. | Mandatory |
| CompanyName | User input: company name. | Mandatory |
| PostalCode | Postal code. | Mandatory |
| Country | ISO 3-letter country code. | Mandatory |
| Filter |
Company status filter. Several values can be separated
by commas. 1 — Opened diffusible 2 — Closed diffusible 3 — Closed old (+3 years) diffusible 4 — Non-diffusible 5 — RNA Example: Filter=1,2
Optional. Default value:
1
|
Optional |
| NAF25 |
Get the new value of Sic Code in France or not: True
/ False
Optional. Default value:
False
|
Optional |
Test the API
Click the button below to test this endpoint live in your browser.
Open console
Response
This response shape is shared by all three request modes above
(lookupcname, lookupcnum and
checkcname).
The JSON response is a dictionary (object) containing two main keys:
- Found: integer indicating the number of companies found.
- Companies: list containing one or more company objects.
Each company object contains the following keys:
| Key | Description | Type / Constraints |
|---|---|---|
| City | City where the company is located. | String, up to 100 characters |
| L1Standardized | Standardized address line 1, often the registered name. | String, up to 255 characters |
| MainCompanyFlag |
Indicates if this is the main company record. 1:
yes; 0: no.
|
String or integer |
| CompanyStatus |
Administrative status of the company. 0:
active.
|
String or integer |
| VatNumber |
Intra-Community VAT number. This field is empty if the company is not subject to VAT. |
String |
| SearchRef | Internal reference linking the result to the search request. | String |
| PhoneNumber | Company phone number. | String |
| LegalStructure | Legal form of the company. |
Array of objects: { Value, Label }
|
| L2Standardized | Standardized address line 2. | String |
| CompanyNumber | Set of legal identifiers, such as SIREN and NIC. |
Array of objects: { Type, Value }
|
| CompanyCName | Commercial name or full company name. | String |
| IncorporationDate | Date the company was created. |
String, YYYY-MM-DD
|
| StaffCount | Declared employee count or range. | String |
| Classification | Business activity classification codes. |
Array of objects: { Type, Value, Label }
|
| L5Standardized | Standardized address line 5. | String |
| DissolutionDate | Date the company ceased to exist, if applicable. |
String, YYYY-MM-DD
|
| L4Standardized | Standardized address line containing street and number. | String |
| PosCod | Postal code. | String, up to 10 characters |
| TurnOver | Reported turnover or revenue. | String or number |
Response example
Example: "DQE SOFTWARE" in Paris
{
"Found": 1,
"Companies": [
{
"City": "PARIS",
"L1Standardized": "DQE-SOFTWARE",
"MainCompanyFlag": "0",
"CompanyStatus": "0",
"VatNumber": "FR 85 504403387",
"SearchRef": "_33170132",
"PhoneNumber": "",
"LegalStructure": [
{
"Value": "5710",
"Label": "SAS, société par actions simplifiée"
}
],
"L2Standardized": "",
"CompanyNumber": [
{
"Type": "Siren",
"Value": "504xxxxxx"
},
{
"Type": "Nic",
"Value": "xxxxx"
}
],
"CompanyCName": "DQE SOFTWARE",
"IncorporationDate": "2014-11-17",
"StaffCount": "Non-employer",
"Classification": [
{
"Type": "NAF08",
"Value": "5829C",
"Label": "Edition de logiciels applicatifs"
}
],
"L5Standardized": "",
"DissolutionDate": "2018-01-31",
"L4Standardized": "42 RUE FORTUNY",
"PosCod": "75017",
"TurnOver": ""
}
]
}
Errors
These errors apply across all three request modes above — the API keys errors by the missing or invalid parameter name, not by endpoint.
| HTTP | Error type | Response body |
|---|---|---|
| 400 |
Missing Licence parameter
|
{"status": 400, "message": "Missing parameters",
"details": "Licence", "error": "bad request"}
|
| 400 |
Empty Licence parameter
|
{"status": 400, "message": "Missing parameters",
"details": "Licence", "error": "bad request"}
|
| 401 | Incorrect licence number |
{"status": 401, "message": "Your licence is not
allowed to cover this functionnality", "details":
"{WRONG LICENSE}", "error": "unauthorized_client"}
|
| 400 |
Missing CompanyName parameter (or
CompanyNumber / PostalCode,
depending on the mode used)
|
{"status": 400, "message": "Missing parameters",
"details": "CompanyName", "error": "bad request"}
|
| 400 |
Missing Country parameter
|
{"status": 400, "message": "Missing parameters",
"details": "Country", "error": "bad request"}
|
| 400 |
Empty CompanyName parameter
|
{"status": 400, "message": "Missing parameters",
"details": "CompanyName", "error": "bad request"}
|
| 200 |
Empty Country parameter — not treated
as an error, returns an empty result
|
{"Found":0,"Companies":[]}
|
See also
Related to