API Restful - Description - B2B - Lookup - Response

Support DQE
Support DQE
  • Updated

This page describes the response returned by the Restful B2B /b2b/lookup endpoint.

Related B2B Restful documentation:

Restful B2B Lookup response

Success response

The JSON response is an array of companies matching the search criteria.

Key Description Type
searchRef Reference used for GetInfo requests. STRING
companyNumber Company SIRET number. STRING
companyName Company legal name. STRING
companyCommercialName Trade name of the company. STRING
companyAddress Full company address. STRING
zipCode Postal code. STRING
city City name. STRING
country ISO 3-letter country code. STRING
companyStatus Administrative status of the company. STRING
score Matching score. INTEGER

Example:

[
  {
    "searchRef": "_29613410",
    "companyNumber": "50440338700047",
    "companyName": "DQE-SOFTWARE",
    "companyCommercialName": "DQE",
    "companyAddress": "102 RUE VICTOR HUGO",
    "zipCode": "92300",
    "city": "LEVALLOIS PERRET",
    "country": "FRA",
    "companyStatus": "ACTIVE",
    "score": 100
  }
]

Error response

Error type Response type
Missing or invalid authentication 401 Unauthorized
Missing mandatory parameter 400 Bad Request
No company found Empty array

Related to

Was this article helpful?

0 out of 0 found this helpful