API Restful - Description - B2B - GetInfo - Response

Support DQE
Support DQE
  • Updated

This page describes the response returned by the Restful B2B /b2b/get-info endpoint.

Related B2B Restful documentation:

Success

Compressed form

The JSON response is an object containing two main keys:

  • Found: number of companies found.
  • Companies: list containing one or more company objects.

Each company object contains the following keys:

Key Description Type / Constraints
L1Standardized Standardized address line 1, often the registered name. String, up to 255 characters
MainCompanyFlag Indicates whether this is the main company record. 1: yes; 0: no. String or integer
CompanyStatus Administrative status of the company. String or integer
Country ISO 3166-1 alpha-3 country code. String, 3 characters
VatNumber Company VAT identification number. String
City City where the company is located. String, up to 100 characters
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
Email Company email address. String
CompanyNumber Legal identifiers, such as SIREN and NIC. Array of objects: { Type, Value }
CompanyCName Commercial name or alternative company name. String
Fax Company fax number. String
IncorporationDate Company creation date. String, YYYY-MM-DD
StaffCount Number of employees or employee range. String
L5Standardized Standardized address line 5. String
DissolutionDate Company dissolution date, if applicable. String, YYYY-MM-DD
Classification Activity classification codes, such as NAF. Array of objects: { Type, Value, Label }
L4Standardized Standardized street address. String
CompanyName2 Secondary company name. String
TurnOver Reported turnover. String or number
PosCod Postal code. String, up to 10 characters

Example:

{
  "Found": 1,
  "Companies": [
    {
      "L1Standardized": "LAPIED CARRELAGE",
      "MainCompanyFlag": "1",
      "CompanyStatus": "1",
      "Country": "FRA",
      "VatNumber": "FR 62 402284269",
      "City": "MONETEAU",
      "SearchRef": "_24663079",
      "PhoneNumber": "",
      "LegalStructure": [
        {
          "Value": "5499",
          "Label": "Société à responsabilité limitée (sans autre indication)"
        }
      ],
      "L2Standardized": "",
      "Email": "",
      "CompanyNumber": [
        {
          "Type": "Siren",
          "Value": "402284269"
        },
        {
          "Type": "Nic",
          "Value": "00022"
        }
      ],
      "CompanyCName": "",
      "Fax": "",
      "IncorporationDate": "2000-09-15",
      "StaffCount": "3-5",
      "L5Standardized": "",
      "DissolutionDate": "",
      "Classification": [
        {
          "Type": "NAF08",
          "Value": "4333Z",
          "Label": ""
        }
      ],
      "L4Standardized": "4 RUE DES CAILLOTTES",
      "CompanyName2": "",
      "TurnOver": "",
      "PosCod": "89470"
    }
  ]
}

Extended form

The JSON response is an object containing two main keys:

  • Found: number of companies found.
  • Companies: list containing one or more company objects.

Each company object contains the following keys:

Key Description Type / Constraints
Title Title associated with the company record. String
ClassificationEnt Enterprise-level activity classification codes. Array of objects: { Type, Value, Label }
Department French department code. String
SocialSolidarityEconomy Indicator of social solidarity economy classification. String
ActivityType Type of activity. String
RangeCodeStaffCountEnt Staff count range code for the enterprise. String
PhoneNumber Company phone number. String
CompanyNumber Legal identifiers, such as SIREN and NIC. Array of objects: { Type, Value }
CityId Internal city identifier. String
NatureCode Code representing the company nature. String
StreetName Street name without number. String
District District or arrondissement. String
FourthActivityEnt Fourth declared activity of the enterprise. String
State Region or state label. String
NatureLastUpdate Indicator of nature update type. String
Acronym Company acronym. String
ThirdActivityEnt Third declared activity of the enterprise. String
DistributionDate Date of distribution or publication. String
EntYearValidity Validity year for enterprise data changes. String
L1Standardized Standardized address line 1. String
StartDateActivities Date activities started. String, YYYY-MM-DD
L2Registered Registered address line 2. String
Distribution Distribution indicator. String
L3Standardized Standardized address line 3. String
Seasonality Seasonality indicator. String
EmployementArea Employment area code. String
PosCod Postal code. String
Category Company size category. String
SecondActivityEnt Second declared activity of the enterprise. String
FirstName First name of the representative. String
IndPublipo Publicity indicator. String
MainActivityMethodEnt Method used for determining the main activity. String
L6Registered Registered address line 6. String
L4Standardized Standardized address line 4. String
CharityNumber Registered charity identifier, if applicable. String
NatureLabel Label describing company nature. String
ProductiveEnt Productive enterprise indicator. String
Classification Activity classification codes. Array of objects: { Type, Value, Label }
L4Registered Registered address line 4. String
City City name. String
StateCode Region or state administrative code. String
ActivityPlace Place where the main activity occurs. String
SpecificProduction Specific production indicator. String
RangeLabelStaffCount Staff count range label. String
NicHeadquarter NIC identifier of the headquarters. String
ClassificationYear Year associated with the activity classification. String
MainActivityMethod Method used to define the main activity. String
TurnOver Company turnover. String or number
IncorporationDateEnt Date of enterprise incorporation. String, YYYY-MM-DD
StaffCountYearEnt Reference year for enterprise staff count. String
UrbanUnitNumber Urban unit code. String
StaffCountYear Year for staff count measurement. String
L7Standardized Standardized address line 7. String
StaffCountEnt Enterprise staff count. String
StoreType Store type classification. String
IncorporationDate Company incorporation date. String, YYYY-MM-DD
RangeLabelStaffCountEnt Staff count range label for enterprise. String
StreetNum Street number. String
RangeCodeStaffCount Code representing staff count range. String
L5Standardized Standardized address line 5. String
MainActivity Main activity code. String
AuxiliaryActivity Auxiliary activity code. String
PoBox PO box number. String
StreetType Type of street. String
VatNumber VAT identification number. String
Email Company email address. String
StaffCount Staff count. String
L3Registered Registered address line 3. String
L1Registered Registered address line 1. String
UrbanUnitDpt Urban unit departmental code. String
UrbanUnitRange Range of the urban unit. String
L6Standardized Standardized address line 6. String
Origine Origin of the company record. String
CompNum Additional company number. String
CompanyCName Commercial company name. String
Headquarter Indicates if the record is the headquarters. String or integer
L2Standardized Standardized address line 2. String
Productive Productive establishment indicator. String
LastName Last name of the representative. String
NatureLastUpdate1 / NatureLastUpdate2 / NatureLastUpdate3 Additional update nature indicators. String
DetailCityRange Detailed city range code. String
MonoActivity Indicates whether the company has a single activity. String
L5Registered Registered address line 5. String
StateCodeEnt Enterprise state or region code. String
County County code. String
L7Registered Registered address line 7. String
ClassificationYearEnt Enterprise classification year. String
LegalStructure Legal structure list. Array of objects: { Value, Label }
LongCompanyName Full official company name. String
SocialSolidarityEconomyDate Date of entry into social solidarity economy. String
CityIdEn Extended city identifier. String
PublicCompCoopIntercom Intercommunal cooperation code. String
FirstActivityEnt First declared enterprise activity. String
LastUpdate Date of last data update. String
MainActivityEnt Main enterprise activity code. String
DistributionDateEnt Distribution date for enterprise-level data. String

Example:

{
  "Found": 1,
  "Companies": [
    {
      "Title": "",
      "ClassificationEnt": [
        {
          "Type": "NAF08",
          "Value": "4333Z",
          "Label": "Travaux de revêtement des sols et des murs"
        }
      ],
      "Department": "89",
      "SocialSolidarityEconomy": "",
      "ActivityType": "",
      "RangeCodeStaffCountEnt": "02",
      "PhoneNumber": "",
      "CompanyNumber": [
        {
          "Type": "Siren",
          "Value": "402284269"
        },
        {
          "Type": "Nic",
          "Value": "00022"
        }
      ],
      "CityId": "263",
      "NatureCode": "",
      "StreetName": "DES CAILLOTTES",
      "District": "1",
      "FourthActivityEnt": "",
      "State": "BOURGOGNE FRANCHE COMTE",
      "NatureLastUpdate": "F",
      "Acronym": "",
      "ThirdActivityEnt": "",
      "DistributionDate": "",
      "EntYearValidity": "",
      "L1Standardized": "LAPIED CARRELAGE",
      "StartDateActivities": "2000-09-15",
      "L2Registered": "",
      "Distribution": "O",
      "L3Standardized": "",
      "Seasonality": "",
      "EmployementArea": "2612",
      "PosCod": "89470",
      "Category": "PME",
      "SecondActivityEnt": "",
      "FirstName": "",
      "IndPublipo": "",
      "MainActivityMethodEnt": "",
      "L6Registered": "89470 MONETEAU",
      "L4Standardized": "4 RUE DES CAILLOTTES",
      "CharityNumber": "",
      "NatureLabel": "",
      "ProductiveEnt": "",
      "Classification": [
        {
          "Type": "NAF08",
          "Value": "4333Z",
          "Label": "Travaux de revêtement des sols et des murs"
        }
      ],
      "L4Registered": "4 RUE DES CAILLOTTES",
      "City": "MONETEAU",
      "StateCode": "27",
      "ActivityPlace": "",
      "SpecificProduction": "",
      "RangeLabelStaffCount": "3-5",
      "NicHeadquarter": "00022",
      "ClassificationYear": "1995",
      "MainActivityMethod": "",
      "TurnOver": "",
      "IncorporationDateEnt": "1995-09-01",
      "StaffCountYearEnt": "2023",
      "UrbanUnitNumber": "02",
      "StaffCountYear": "2023",
      "L7Standardized": "FRA",
      "StaffCountEnt": "",
      "StoreType": "",
      "IncorporationDate": "2000-09-15",
      "RangeLabelStaffCountEnt": "3-5",
      "StreetNum": "4",
      "RangeCodeStaffCount": "02",
      "L5Standardized": "",
      "MainActivity": "4333ZZ",
      "AuxiliaryActivity": "",
      "PoBox": "",
      "StreetType": "RUE",
      "VatNumber": "FR 62 402284269",
      "Email": "",
      "StaffCount": "",
      "L3Registered": "",
      "L1Registered": "LAPIED CARRELAGE",
      "UrbanUnitDpt": "89",
      "UrbanUnitRange": "4",
      "L6Standardized": "89470 MONETEAU",
      "Origine": "",
      "CompNum": "",
      "CompanyCName": "",
      "Headquarter": "1",
      "L2Standardized": "",
      "Productive": "",
      "LastName": "",
      "NatureLastUpdate1": "",
      "NatureLastUpdate3": "",
      "NatureLastUpdate2": "",
      "DetailCityRange": "17",
      "MonoActivity": "",
      "L5Registered": "",
      "StateCodeEnt": "",
      "County": "02",
      "L7Registered": "FRA",
      "ClassificationYearEnt": "",
      "LegalStructure": [
        {
          "Value": "5499",
          "Label": "Société à responsabilité limitée (sans autre indication)"
        }
      ],
      "LongCompanyName": "LAPIED CARRELAGE",
      "SocialSolidarityEconomyDate": "",
      "CityIdEn": "89263",
      "PublicCompCoopIntercom": "200067114",
      "FirstActivityEnt": "",
      "LastUpdate": "2025-01-22",
      "MainActivityEnt": "",
      "DistributionDateEnt": ""
    }
  ]
}

Error

Compressed form

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/{VERSION}/infosr/?SEARCH_REF=_24663079&Country=FRA&Licece={LICENSE} {"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"}
Empty Licence parameter https://{SERVER_ADDRESS}/{VERSION}/infosr/?SEARCH_REF=_24663079&Country=FRA&Licence= {"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"}
Error on a parameter https://{SERVER_ADDRESS}/{VERSION}/infosr/?SEARH_REF=&Country=FRA&Licence={LICENSE} {"status":400,"message":"Missing parameters","details":"SEARCH_REF","error":"bad request"}

Extended form

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/{VERSION}/infocnum/40228426900022&Country=FRA&Licece={LICENSE} {"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"}
Empty Licence parameter https://{SERVER_ADDRESS}/{VERSION}/infocnum/40228426900022&Country=FRA&Licence= {"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"}

Related to

Was this article helpful?

0 out of 0 found this helpful