Restful B2B API — Lookup

Support DQE
Support DQE
  • Updated

Use this endpoint to search for companies and return a list of matching results.

Related Restful B2B API documentation:

GET request

CompanyName or CompanyNumber only

GET https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}

Simply replace the items in braces with your information.

Parameter Description Mandatory/Optional
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 or CompanyNumber User input: company name or 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

Company Name and Postal Code

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parameter Description Mandatory/Optional
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
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

Postal Address only

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parameter Description Mandatory/Optional
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
Address Street type and street name of the business address. Mandatory
PostalCode Postal code. Mandatory
City City 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

POST request

Add the parameters below in the body using x-www-form-urlencoded.

CompanyName or CompanyNumber only

POST https://{SERVER_ADDRESS}/{VERSION}/lookupcname/
Parameter Description Mandatory/Optional
Licence Number assigned to you as your licence code. Mandatory
CompanyName or CompanyNumber User input: company name or 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

Company Name and Postal Code

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parameter Description Mandatory/Optional
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

Postal Address only

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parameter Description Mandatory/Optional
Licence Number assigned to you as your licence code. Mandatory
Address Street type and street name of the business address. Mandatory
PostalCode Postal code. Mandatory
City City 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

Response

Success

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 Company VAT identification number. 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

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

Error

Error type Request Response 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 parameter https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence= {"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Incorrect licence number https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence={WRONG LICENSE} {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{WRONG LICENSE}", "error": "unauthorized_client"}
Missing CompanyName parameter https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Missing Country parameter https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"}
Empty CompanyName parameter https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=&Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Empty Country parameter https://{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