Criar uma Empresa

Esse endpoint permite o cadastro de uma nova empresa, um participante do processo de contratação do crédito para o Originador.

Uma Empresa é a representação de uma companhia na Plataforma, e assim como uma Pessoa, uma Empresa pode assumir diferentes funções dentro de solicitações e os dados necessários para cada uma dessas funções podem variar de acordo com o as configurações do Produto.

Parâmetros do Body

  • taxpayer_id (string, obrigatório): O nº do CNPJ da empresa a ser cadastrada.

  • legal_name (string, obrigatório): A razão social da empresa a ser cadastrada.

  • name (string, obrigatório): O nome fantasia da empresa a ser cadastrada.

  • email_address(string, obrigatório): Campo de e-mail para contato com a Empresa. Deve ser um e-mail válido no formato "email@dominio".

  • foundation_date(string, obrigatório): Data de abertura/registro da Empresa na Receita Federal".

  • phone(string, obrigatório): Objeto contendo o número do telefone para contato com a empresa.

    • area_code(string, obrigatório): Campo do código da área (DDD).

    • country_code(string, obrigatório): Código Internacional para identificação do país (DDI).

    • number(string, obrigatório): Número do telefone, somente os números.

    • formatted_number(string): Número do telefone formatado.

  • incorporation_type(string, obrigatório): Regime legal da Empresa cadastrado na Receita Federal. Valores aceitos: EIRELI, LTDA, MEI, SA, SS.

  • tax_regime(string, obrigatório): Regime tributário da Empresa. Valores aceitos: PRESUMED_PROFIT, REAL_PROFIT, SIMPLE.

  • industry_classification(string, obrigatório): Classificação para a área de atuação da Empresa (CNAE).

  • address(string, obrigatório): Objeto contendo os dados do endereço da Empresa.

    • street_name(string, obrigatório): Nome do logradouro do endereço.

    • street_number(integer, obrigatório): Númeração do endereço. Se conter letras enviar no campo "extra_info".

    • extra_info(string): Campo para dados adicionais, complemento, do Endereço.

    • district(string, obrigatório): Bairro do endereço.

    • city(string, obrigatório): Cidade do endereço.

    • postal_code (string): Código de CEP para o endereço.

    • state_code(string, obrigatório): Sigla para identificação do estado/uf. Exemplo: SP.

    • country_code(string, obrigatório): Código do país. Exemplo: BR.

  • pix (object): Objeto contendo os dados de uma chave PIX.

    • key (string): Chave PIX.

    • key_type (string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID

  • external_bank_account (object): Objeto contendo os dados bancários.

    • bank_code (string): Código do banco.

    • bank_account (string): Número da conta

    • bank_account_digit (string): Dígito do número da conta.

    • bank_branch (string): Número da agência.

    • bank_account_type (string): Tipo da conta bancária. Valores aceitos: CACC, TRAN, SLRY, SVGS.

    • ispb_code (string): Código da Instituição recebedora no Sistema de Pagamentos Instantâneo.

  • billing_address(string, obrigatório): Objeto contendo os dados do endereço da Empresa para cobrança.

    • street_name(string, obrigatório): Nome do logradouro do endereço.

    • street_number(integer, obrigatório): Númeração do endereço. Se conter letras enviar no campo "extra_info".

    • extra_info(string): Campo para dados adicionais, complemento, do Endereço.

    • district(string, obrigatório): Bairro do endereço.

    • city(string, obrigatório): Cidade do endereço.

    • postal_code (string): Código de CEP para o endereço.

    • state_code(string, obrigatório): Sigla para identificação do estado/uf. Exemplo: SP.

    • country_code(string, obrigatório): Código do país. Exemplo: BR.

  • share_capital(float): Capital social da eEmpresa.

  • monthly_revenue(float): Faturamento mensal estimado para a Empresa.

  • employer(boolean): Campo booleano que indica se essa empresa deve suportar ou não o cadastro de colaboradores vinculados a ela.

  • custom_variables(objeto): Objeto contendo valores de variáveis personalizadas, no formato de "chave e valor".

Resposta

Se a requisição for processada com sucesso será retornado um status 201.

Language
Credentials
OAuth2
Required Scopes
URL
Click Try It! to start a request and see the response here!