API Restful - Description - B2B - Lookup - Response

Support DQE
Support DQE
  • Updated

Lookupcname / Checkcname / Lookupcadr response success

The JSON response is a dictionary (object) containing two main keys:

  • "Found": an integer indicating the number of addresses found (e.g., 0 or 1),
  • "Companies": a list containing one or more Company objects.

Each company object is itself a dictionary containing the following keys:

 

KeyDescriptionSize / Type
CityCity where the company is located.String (up to 100 characters)
L1StandardizedStandardized line 1 of the address (often the registered name).String (up to 255 characters)
MainCompanyFlagIndicates if this is the main company record (0 = no, 1 = yes).String or Integer (0/1)
CompanyStatusAdministrative status of the company (0 = active, other values depending on source).String or Integer
VatNumberCompany VAT identification number.String
SearchRefInternal reference linking the result to the search request.String
PhoneNumberCompany phone number.String
LegalStructureLegal form of the company; list of code and label pairs.Array of objects { Value, Label }
L2StandardizedStandardized line 2 of the address (e.g., “c/o”, additional location details).String
CompanyNumberSet of legal identifiers (e.g., SIREN, NIC).Array of objects { Type, Value }
CompanyCNameCommercial name or full company name.String
IncorporationDateDate the company was created.String (YYYY-MM-DD)
StaffCountDeclared employee count (may be a qualitative label).String
ClassificationBusiness activity classification codes.Array of objects { Type, Value, Label }
L5StandardizedStandardized address line 5 (often empty).String
DissolutionDateDate the company ceased to exist, if applicable.String (YYYY-MM-DD)
L4StandardizedStandardized address line containing street and number.String
PosCodPostal code.String (up to 10 characters)
TurnOverReported turnover or revenue (may be empty).String or Number

 

Example:

{
 "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": ""
   }
 ]
}

 

Lookupcname / Checkcname / Lookupcadr response error

Error typeRequestResponse type
Missing “Licence” parameter https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Empty “Licence” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence={"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Incorrect licence numberhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence={WRONG%20LICENSE}{"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{WRONG LICENSE}", "error": "unauthorized_client"}
Missing “CompanyName” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?Companyame=dqe%20paris&Country=FRA&Licence={LICENSE}{"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Missing “Country” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Contry=FRA&Licence={LICENSE}{"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"}
Empty “CompanyName” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=&Country=FRA&Licence={LICENSE}{"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Empty “Country” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=&Licence={LICENSE}{"Found":0,"Companies":[]}

Related to

Was this article helpful?

0 out of 0 found this helpful