API B2B — Rechercher des entreprises
Utilisez ce endpoint pour rechercher des entreprises et obtenir une liste des résultats correspondants.
Documentation API B2B Restful associée :
Nom d'entreprise uniquement
Recherchez des entreprises à partir de leur raison sociale enregistrée.
lookupcname
Requête
GET et POST sont toutes deux prises en charge.
{SERVER_ADDRESS}, {VERSION} et {LICENCE_CODE} sont fournis par DQE lors de la création de votre compte. Contactez votre gestionnaire de compte DQE pour obtenir ces identifiants.
GEThttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Remplacez simplement les éléments entre accolades par vos informations.
Exemples de code
Rechercher « dqe paris » en 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/
Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.
Exemples de code
Rechercher « dqe paris » en 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))
}
Paramètres
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Adresse du serveur DQE qui traitera les données. | Mandatory |
| VERSION | Version de l'API. Exemple : v1
|
Mandatory |
| Licence | Numéro qui vous a été attribué comme code de licence. | Mandatory |
| CompanyName | Saisie utilisateur : nom de l'entreprise. | Mandatory |
| Country | Code pays ISO à 3 lettres. | Mandatory |
| Filter | Filtre de statut d'entreprise. Plusieurs valeurs peuvent être séparées par des virgules. 1 — Diffusible ouverte 2 — Diffusible fermée 3 — Ancienne diffusible, fermée depuis plus de 3 ans 4 — Non diffusible 5 — RNA Exemple : Filter=1,2Optionnel. Valeur par défaut :
1
|
Optional |
| NAF25 | Obtenir ou non la nouvelle valeur du Code Sic en France : True / False Optionnel. Valeur par défaut :
False
|
Optional |
Tester l'API
Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.
Ouvrir la console
Numéro d'entreprise uniquement
Recherchez des entreprises à partir de leur numéro d'entreprise.
lookupcnum
Requête
GET et POST sont toutes deux prises en charge.
{SERVER_ADDRESS}, {VERSION} et {LICENCE_CODE} sont fournis par DQE lors de la création de votre compte. Contactez votre gestionnaire de compte DQE pour obtenir ces identifiants.
GEThttps://{SERVER_ADDRESS}/{VERSION}/lookupcnum/?CompanyNumber={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Remplacez simplement les éléments entre accolades par vos informations.
Exemples de code
Rechercher par numéro d'entreprise en 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/
Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.
Exemples de code
Rechercher par numéro d'entreprise en 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))
}
Paramètres
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Adresse du serveur DQE qui traitera les données. | Mandatory |
| VERSION | Version de l'API. Exemple : v1
|
Mandatory |
| Licence | Numéro qui vous a été attribué comme code de licence. | Mandatory |
| CompanyNumber | Saisie utilisateur : numéro de l'entreprise. | Mandatory |
| Country | Code pays ISO à 3 lettres. | Mandatory |
| Filter | Filtre de statut d'entreprise. Plusieurs valeurs peuvent être séparées par des virgules. 1 — Diffusible ouverte 2 — Diffusible fermée 3 — Ancienne diffusible, fermée depuis plus de 3 ans 4 — Non diffusible 5 — RNA Exemple : Filter=1,2Optionnel. Valeur par défaut :
1
|
Optional |
| NAF25 | Obtenir ou non la nouvelle valeur du Code Sic en France : True / False Optionnel. Valeur par défaut :
False
|
Optional |
Tester l'API
Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.
Ouvrir la console
Nom d'entreprise et code postal
Recherchez des entreprises à partir de leur nom combiné à un code postal, pour une correspondance plus précise.
checkcname
Requête
GET et POST sont toutes deux prises en charge.
{SERVER_ADDRESS} et {LICENCE_CODE} sont fournis par DQE lors de la création de votre compte. Contactez votre gestionnaire de compte DQE pour obtenir ces identifiants.
Spécifique à une version : cette opération n'est disponible que sur la version
v1 de l'API — elle n'est pas disponible sur la v2. Utilisez v1 dans l'URL pour cette opération spécifiquement, même si les autres opérations B2B Restful prennent en charge les deux versions. GEThttps://{SERVER_ADDRESS}/v1/checkcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Remplacez simplement les éléments entre accolades par vos informations.
Exemples de code
Rechercher « dqe paris » près du code postal 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/
Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.
Exemples de code
Rechercher « dqe paris » près du code postal 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))
}
Paramètres
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Adresse du serveur DQE qui traitera les données. | Mandatory |
| VERSION | Fixé à v1 pour cette opération — non configurable, v2 ne la prend pas en charge. |
Mandatory |
| Licence | Numéro qui vous a été attribué comme code de licence. | Mandatory |
| CompanyName | Saisie utilisateur : nom de l'entreprise. | Mandatory |
| PostalCode | Code postal. | Mandatory |
| Country | Code pays ISO à 3 lettres. | Mandatory |
| Filter | Filtre de statut d'entreprise. Plusieurs valeurs peuvent être séparées par des virgules. 1 — Diffusible ouverte 2 — Diffusible fermée 3 — Ancienne diffusible, fermée depuis plus de 3 ans 4 — Non diffusible 5 — RNA Exemple : Filter=1,2Optionnel. Valeur par défaut :
1
|
Optional |
| NAF25 | Obtenir ou non la nouvelle valeur du Code Sic en France : True / False Optionnel. Valeur par défaut :
False
|
Optional |
Tester l'API
Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.
Ouvrir la console
Réponse
Ce format de réponse est partagé par les trois modes de requête ci-dessus (lookupcname, lookupcnum et checkcname).
La réponse JSON est un dictionnaire (objet) contenant deux clés principales :
- Found : entier indiquant le nombre d'entreprises trouvées.
- Companies : liste contenant un ou plusieurs objets entreprise.
Chaque objet entreprise contient les clés suivantes :
| Clé | Description | Type / Contraintes |
|---|---|---|
| City | Ville où est située l'entreprise. | String, up to 100 characters |
| L1Standardized | Ligne d'adresse normalisée 1, souvent la raison sociale. | String, up to 255 characters |
| MainCompanyFlag | Indique s'il s'agit de l'établissement principal. 1 : oui ; 0 : non. |
String or integer |
| CompanyStatus | Statut administratif de l'entreprise. 0 : active. |
String or integer |
| VatNumber | Numéro de TVA intracommunautaire. Ce champ est vide si l'entreprise n'est pas assujettie à la TVA. |
String |
| SearchRef | Référence interne reliant le résultat à la requête de recherche. | String |
| PhoneNumber | Numéro de téléphone de l'entreprise. | String |
| LegalStructure | Forme juridique de l'entreprise. | Array of objects: { Value, Label }
|
| L2Standardized | Ligne d'adresse normalisée 2. | String |
| CompanyNumber | Ensemble d'identifiants légaux, tels que SIREN et NIC. | Array of objects: { Type, Value }
|
| CompanyCName | Nom commercial ou raison sociale complète. | String |
| IncorporationDate | Date de création de l'entreprise. | String, YYYY-MM-DD
|
| StaffCount | Effectif déclaré ou tranche d'effectif. | String |
| Classification | Codes de classification de l'activité. | Array of objects: { Type, Value, Label }
|
| L5Standardized | Ligne d'adresse normalisée 5. | String |
| DissolutionDate | Date de cessation d'activité de l'entreprise, le cas échéant. | String, YYYY-MM-DD
|
| L4Standardized | Ligne d'adresse normalisée contenant la voie et le numéro. | String |
| PosCod | Code postal. | String, up to 10 characters |
| TurnOver | Chiffre d'affaires déclaré. | String or number |
Exemple de réponse
Exemple : « DQE SOFTWARE » à 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": ""
}
]
}
Erreurs
Ces erreurs s'appliquent aux trois modes de requête ci-dessus — l'API identifie les erreurs par le nom du paramètre manquant ou invalide, pas par endpoint.
| HTTP | Type d'erreur | Corps de la réponse |
|---|---|---|
| 400 | Paramètre Licence manquant |
{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"} |
| 400 | Paramètre Licence vide |
{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"} |
| 401 | Numéro de licence incorrect | {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{WRONG LICENSE}", "error": "unauthorized_client"} |
| 400 | Paramètre CompanyName manquant (ou CompanyNumber / PostalCode, selon le mode utilisé) |
{"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"} |
| 400 | Paramètre Country manquant |
{"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"} |
| 400 | Paramètre CompanyName vide |
{"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"} |
| 200 | Paramètre Country vide — non traité comme une erreur, retourne un résultat vide |
{"Found":0,"Companies":[]} |
Voir aussi
Associé à