API Reference

Use Cases

This is the section of the documentation intended to clarify use cases related to the Establishments API. Here, you will find usage examples and notes on API utilization.

Establishment Creation

The establishment creation can only be used by establishments created as whitelabel on our platform. Thus, establishments created as stores cannot enjoy this functionality, as the purpose of this endpoint is to enable the creation of stores for companies that have others below them, such as franchisors, headquarters, and others.

Furthermore, consider establishments as any companies/users of the platform, whether they are individuals or legal entities. Therefore, in the establishment creation endpoint, it is possible to create establishments in the name of both individuals and legal entities.

Establishment Creation - Individual

For the creation of establishments in the name of an individual, some adaptation considerations need to be made for sending the request to the API:

  • Consider the parameter commercialName as the brand name of the individual;
  • Consider the parameter socialReason as the full name of the individual;
  • Consider the parameter documentNumber as the individual's taxpayer identification number (CPF);
  • Consider the parameter cnaeId as the identifier ID of the CNAE 7490-1/99 reserved for individuals on our platform (click here to obtain more information from the CNAE list endpoint);
  • Consider the parameter foundationDate as the birth date of the individual.
  • Consider the parameter companyFormationCode equal to 06 - Individual Limited Liability Company for individuals.
  • Consider the parameter representative as the data of the individual themselves.
  • Consider the parameter address as the address of the individual.

Furthermore, the bank account must be linked to the individual's taxpayer identification number (CPF) and their registration data, and it's where the payment settlements created on the platform will be processed.

Establishment Creation - Legal Entity

Creating an establishment in the name of a legal entity is straightforward and follows the necessary parameters in the establishment creation endpoint. However, it is essential that the data sent aligns with the CNPJ card of the company. Establishment registrations with inconsistent information such as company composition type, egistered addresses, representatives, among others, may be rejected.

On the other hand, just like with individuals, the bank account must be linked to the establishment's CNPJ, as payment settlements will not be processed for bank accounts not linked to the CNPJ.