Sign in

v1

latestOpenAPI 3.0.02026-07-24310185.2 KB
Company

Get Company 🇫🇷

Returns the basic information of the company with french specific data.
Required scopes: None

get/companies-fr/{companyId}

Path parameters

companyIdstring required

The id of the company

Response

The french fetched company

idstring required

Id of the company.

namestring required

Name of the company.

country'FR' | 'ES' | 'GB' required

Country of the company.

identificationNumberstring required

Identification number of the company (e.g. SIRET for France, CIF for Spain, ...).

addressstring required

The company's address

citystring required

The city of the company

postalCodestring required

The postal code of the company

nbActiveContractsinteger required

Number of current active contracts within the company.

sirenstring required

"Système Identification Répertoire Entreprises" of the company. Deprecated: use identificationNumber instead (first 9 characters).

siretstring required

"Système Identification Répertoire Etablissements" of the company. Deprecated: use identificationNumber instead.

healthInsuranceProrationMethod'WORKING_DAYS' | 'CALENDAR_DAYS' | 'THIRTY_DAYS' | 'null' nullable required

The method to prorate the health insurance. This field is set only if the 'health-insurance:read' scope is set.