API B2B — Rechercher des entreprises (REST)

Utilisez cet endpoint pour rechercher des entreprises et obtenir une liste des résultats correspondants.

Documentation API B2B Restful associée :

• API B2B — Introduction
• Restful B2B API — GetInfo

Requête GET

CompanyName ou CompanyNumber uniquement

lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}

Remplacez simplement les éléments entre accolades par vos informations.

Nom d'entreprise et Code postal

checkname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}

Remplacez simplement les éléments entre accolades par vos informations.

Adresse postale uniquement

checkname/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}

Remplacez simplement les éléments entre accolades par vos informations.

Requête POST

Ajoutez les paramètres ci-dessous dans le corps de la requête en utilisant x-www-form-urlencoded.

CompanyName ou CompanyNumber uniquement

POST .../lookupcname/

Nom d'entreprise et Code postal

POST .../checkname/

Adresse postale uniquement

POST .../checkname/

Réponse

Succès

La réponse JSON est un dictionnaire (objet) contenant deux clés principales :

• Found : entier indiquant le nombre d'entreprises trouvées.
• Companies : liste des objets entreprise correspondant à la recherche.

Chaque objet entreprise contient les clés suivantes :

Exemple :

{
  "Found": 1,
  "Companies": [
    {
      "City": "PARIS",
      "L1Standardized": "DQE-SOFTWARE",
      "MainCompanyFlag": "1",
      "CompanyStatus": "Active",
      "VatNumber": "FR504xxxxxx",
      "SearchRef": "",
      "PhoneNumber": "",
      "LegalStructure": {
        "Type": "SAS, société par actions simplifiée",
        "Value": "5710",
        "Label": "SAS, société par actions simplifiée"
      },
      "L2Standardized": "42 RUE FORTUNY",
      "CompanyNumber": "504xxxxxx",
      "CompanyCName": "DQE SOFTWARE",
      "IncorporationDate": "2008-xx-xx",
      "StaffCount": "xxxxx",
      "Classification": {
        "Type": "NAF08",
        "Value": "5829C",
        "Label": "Edition de logiciels applicatifs"
      },
      "L5Standardized": "",
      "DissolutionDate": "",
      "L4Standardized": "FRANCE",
      "PosCod": "75017",
      "TurnOver": ""
    }
  ]
}

Erreur

{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}

{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}

{"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{WRONG LICENSE}", "error": "unauthorized_client"}

{"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}

{"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"}

{"Found":0,"Companies":[]}

{"Found":0,"Companies":[]}

Documentation Swagger

• Restful B2B API : Accédez à la documentation Swagger.

Voir aussi

• API Response Codes — Complete Reference