API - Description - B2B - RECSIRET - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by /RECSIRET/, used to search for companies and return matching results.

Related B2B documentation:

RECSIRET response

Success response

The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains a company matching the search criteria.

Key Description Type
Siret Company SIRET number. STRING
Siren Company SIREN number. STRING
RaisonSociale Company legal name. STRING
Enseigne Trade name, when available. STRING
Complement Additional address information. STRING
NumeroVoie Street number. STRING
IndiceRepetition Street number repetition index. STRING
TypeVoie Street type. STRING
LibelleVoie Street name. STRING
CodePostal Postal code. STRING
Ville City name. STRING
Pays Country code. STRING
EtatAdministratif Company administrative status. STRING
Score Matching score for the returned company. STRING

Example:

{
  "1": {
    "Siret": "00000000000000",
    "Siren": "000000000",
    "RaisonSociale": "COMPANY NAME",
    "Enseigne": "",
    "Complement": "",
    "NumeroVoie": "1",
    "IndiceRepetition": "",
    "TypeVoie": "RUE",
    "LibelleVoie": "EXAMPLE",
    "CodePostal": "75000",
    "Ville": "PARIS",
    "Pays": "FRA",
    "EtatAdministratif": "A",
    "Score": "100"
  }
}

Error response

Error type Response type
Missing, empty, or incorrect Licence parameter Empty response or licence error.
Missing mandatory search parameter Empty response.
No company found Empty response.
Parameter typo Empty response or missing-parameter behavior.

Related to

Was this article helpful?

0 out of 0 found this helpful