Companies

Business entity used as the identity of the merchant, buyer, supplier, onboarded customer, or payment counterparty.

Business object

Vue d’ensemble

Company endpoints create, retrieve, enrich, and suspend business entities. A company is scoped to the merchant, may represent the merchant's own identity, and references linked objects through their identifiers in API relationships.

See also the business-model page company for semantics, relationships, and functional lifecycle.

Contrat JSON

Objet company

Responses use the prefixed identifier cmp_ and the field object to make the type explicit.

merchant_idstring

Merchant identifier delimiting the company scope.

legal_namestring

Company legal name. Required at creation.

trade_namestring

Nom commercial optionnel.

display_namestring

Lecture seule : trade_name lorsqu’il existe, sinon legal_name.

registration_countrystring

ISO 3166-1 alpha-2 country used with registration number or tax ID.

registration_numberstring

Local registration number.

tax_identifierstring

Identifiant fiscal.

is_selfboolean

Read-only. `true` for the company referenced by the merchant.

is_buyer / is_supplierboolean

Explicit commercial qualifications, required at creation.

REST

Endpoints

MethodEndpointUsage
POST/v1/companiesCreate a company.
GET/v1/companiesList companies, with filters for `merchant_id`, `source_reference`, `is_buyer`, `is_supplier`, or `group_id`.
GET/v1/companies/searchResolve a unique company by `source_reference`, `registration_number`, `tax_identifier`, or `legal_name`.
GET/v1/companies/{id}Retrieve a company.
POST/v1/companies/{id}Update company business fields.
POST/v1/companies/{id}/suspendSuspend a company.
POST/v1/companies/{id}/reactivateReactivate a suspended company.
GET/v1/companies/{id}/contactsList attached contacts.
GET/v1/companies/{id}/contacts/resolveResolve contacts by role and certification level.
GET/v1/companies/{id}/company-groupsList company groups.
POST/v1/companies/{id}/company-group-linksReplace group memberships.

Events

Associated events

These events can be consumed through platform webhooks when the account is configured to receive them.

company.createdcompany.updatedcompany.suspendedcompany.reactivated

Behavior

Points d’attention

  • `is_self` is computed from the link exposed by `merchant.company_id` and cannot be changed through the Company API.
  • Search returns a `company_search_result` with `company` and `matched_by`.
  • `registration_number`, `tax_identifier`, and `legal_name` also require `country` in search.
  • `receivable`/`payable` endpoints are computed views attached to the company, not mutations of the company itself.