B2B Classic API — RECSIRET

Support DQE
Support DQE
  • Updated

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

Related B2B Classic API documentation:

GET request

The RECSIRET endpoint can be searched by company name, company name and postal code, or postal address.

Company name only

Endpoint

https://{SERVER_ADDRESS}/RECSIRET/?CompanyName={COMPANY_NAME}&Dictionary=Y&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}&NbMax={NB_MAX}
Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
CompanyName {COMPANY_NAME} Company name or part of the company name. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Company name and postal code

Endpoint

https://{SERVER_ADDRESS}/RECSIRET/?ZIP_Code={POSTAL_CODE}&CompanyName={COMPANY_NAME}&Dictionary=Y&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}&NbMax={NB_MAX}
Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
ZIP_Code {POSTAL_CODE} Postal code or department code. Mandatory
CompanyName {COMPANY_NAME} Company name. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Postal address only

Endpoint

https://{SERVER_ADDRESS}/RECSIRET/?Address={ADDRESS}&CP={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Dictionary=Y&Licence={LICENCE_CODE}&Filter={FILTER}&NbMax={NB_MAX}
Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
Address {ADDRESS} Street type and street name of the business address to check. Mandatory
CP {POSTAL_CODE} Postal code of the business address to check. Mandatory
City {CITY} City name of the business address to check. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Filter values

Value Description
1 Opened diffusible companies.
2 Closed diffusible companies.
3 Closed old diffusible companies older than 3 years.
4 Non-diffusible companies.
5 RNA records.

POST request

Endpoint

https://{SERVER_ADDRESS}/RECSIRET/

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

Company name only

Parameter Value Description Mandatory/Optional
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
CompanyName {COMPANY_NAME} Company name or part of the company name. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Company name and postal code

Parameter Value Description Mandatory/Optional
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
ZIP_Code {POSTAL_CODE} Postal code or department code. Mandatory
CompanyName {COMPANY_NAME} Company name. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Postal address only

Parameter Value Description Mandatory/Optional
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
Address {ADDRESS} Street type and street name of the business address to check. Mandatory
CP {POSTAL_CODE} Postal code of the business address to check. Mandatory
City {CITY} City name of the business address to check. Mandatory
Country {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Dictionary Y Enables dictionary-based company search. Mandatory
Filter {FILTER} Company status filter. Several values can be separated by commas. Optional. Default value: 1.
NbMax {NB_MAX} Maximum number of results to return. Optional. Default value: 10.

Filter values

Value Description
1 Opened diffusible companies.
2 Closed diffusible companies.
3 Closed old diffusible companies older than 3 years.
4 Non-diffusible companies.
5 RNA records.

Response

Success

The JSON response is a dictionary whose keys are DATA1, DATA2, etc. Each value is a dictionary containing the company's data. It contains the key SEARCH_REF which is required to retrieve full company details via SIRETINFO.

Key Value France International
SEARCH_REF Search reference, to use as input for SIRETINFO. STRING STRING
CompanyCName Complementary name of the company (or trade name). STRING(50) STRING(255)
LegalStructureLabel Legal form of the company (label). STRING(100) STRING(100)
IncorporationDate Date of company installation in the current city. STRING STRING
MainCompanyFlag 1: head office; 0: other company office. STRING(1) STRING(1)
CompanyStatus 1: company in operation; 0: company no longer in operation. STRING(1) STRING(1)
CompanyName Company name. STRING(131) STRING(255)
CompanyAddress2 Company address. STRING(38) STRING(50)
CompanyAddress3 Additional address information. STRING(38) STRING(50)
CompanyAddress1 May include the second part of the CompanyName if the name is too long. STRING(38) STRING(50)
Locality City of the company. STRING(38) STRING(50)
Phone Not used anymore.
DissolutionDate Date the company ceased to operate. STRING STRING
StaffCount Number of employees. See StaffCount values below. STRING STRING
CompanySIC Company NAF code. STRING(5) STRING
LegalStructureCode Legal form of the company (code). STRING(4) STRING(4)
IntraNumber Intra-Community VAT number. STRING(15) STRING
ZIP_Code ZIP code of the company's city. STRING(5) STRING(10)
TurnOver Not used anymore.
CompanyNumber SIRET number of the company. STRING(14) STRING(14)
Country ISO 3-letter country code. STRING(3) STRING(3)

StaffCount values:

StaffCount value
Not declared
Non-employer
0
1-2
3-5
6-9
10-19
20-49
50-99
100-199
200-249
250-499
500-999
1000-1999
2000-4999
5000-9999
10000+

Example:

{
  "DATA1": {
    "SEARCH_REF": "_13367292",
    "CompanyCName": "",
    "IncorporationDate": "2024-06-24",
    "LegalStructureLabel": "Société européenne",
    "CompanyStatus": "1",
    "CompanyName": "DECATHLON",
    "CompanyAddress1": "",
    "CompanyAddress2": "52 ALLEE LAKANAL",
    "CompanyAddress3": "",
    "Locality": "VILLENEUVE D ASCQ",
    "DissolutionDate": "",
    "Phone": "",
    "MainCompanyFlag": "0",
    "StaffCount": "Non-employer",
    "CompanySIC": "8559A",
    "LegalStructureCode": "5800",
    "IntraNumber": "FR 51 306138900",
    "ZIP_Code": "59650",
    "TurnOver": "",
    "CompanyNumber": "306xxxxxxxxxxx",
    "Country": "FRA"
  }
}

Error

Company name only

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?CompanyName={COMPANY_NAME}&Dictionary=Y&Country=FRA 400 Bad Request Error
Empty Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?CompanyName={COMPANY_NAME}&Dictionary=Y&Country=FRA&Licence= 400 Bad Request Error
Missing or empty CompanyName parameter https://{SERVER_ADDRESS}/RECSIRET/?Dictionary=Y&Country=FRA&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/RECSIRET/?CompanyName=&Dictionary=Y&Country=FRA&Licence={LICENCE_CODE}
{
  "DATA1": {
    "SEARCH_REF": "",
    "CompanyCName": "",
    "IncorporationDate": "",
    "MainCompanyFlag": "",
    "CompanyStatus": "",
    "CompanyName": "",
    "CompanyAddress2": "",
    "CompanyAddress3": "",
    "CompanyNumber": "",
    "CompanyAddress1": "",
    "Locality": "",
    "Phone": "",
    "DissolutionDate": "",
    "CompanySIC": "",
    "LegalStructureCode": "",
    "IntraNumber": "",
    "LegalStructureLabel": "",
    "TurnOver": "",
    "ZIP_Code": "",
    "StaffCount": ""
  }
}
Error on a parameter https://{SERVER_ADDRESS}/RECSIRET/?Companyame={COMPANY_NAME}&Dictionary=Y&Country=FRA&Licence={LICENCE_CODE} Same empty response as above

Company name and postal code

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?ZIP_Code={POSTAL_CODE}&CompanyName={COMPANY_NAME}&Dictionary=Y&Country=FRA Empty response
Empty Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?ZIP_Code={POSTAL_CODE}&CompanyName={COMPANY_NAME}&Dictionary=Y&Country=FRA&Licence= Empty response
Missing or empty CompanyName parameter https://{SERVER_ADDRESS}/RECSIRET/?ZIP_Code={POSTAL_CODE}&Dictionary=Y&Country=FRA&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/RECSIRET/?ZIP_Code={POSTAL_CODE}&CompanyName=&Dictionary=Y&Country=FRA&Licence={LICENCE_CODE}
Same empty response as above

Postal address only

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?Address={ADDRESS}&CP={POSTAL_CODE}&City={CITY}&Dictionary=Y&Country=FRA 400 Bad Request Error
Empty Licence parameter https://{SERVER_ADDRESS}/RECSIRET/?Address={ADDRESS}&CP={POSTAL_CODE}&City={CITY}&Dictionary=Y&Country=FRA&Licence= 400 Bad Request Error
Error on a parameter https://{SERVER_ADDRESS}/RECSIRET/?Address={ADDRESS}&CP={POSTAL_CODE}&City={CITY}&Dictionary=Y&Country=FRA&Licence={LICENCE_CODE} Same empty response as above

Related to

Was this article helpful?

0 out of 0 found this helpful