Registro de MEI, EI, EIRELI ou SLU

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

Conta do Representante Legal previamente aprovada
CNPJ Valido

❗️
Atenção
As informações relacionadas ao CNPJ fornecido devem estar de acordo com os dados mais recentes da empresa, pois realizamos uma verificação em fontes públicas e privadas de informações. Havendo divergência, a análise será reprovada.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Onboarding/enterprise/{{clientId}}

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/enterprise/{{clientId}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--data-raw '{
  "password": "TesteFicticio123@",
  "documentNumber": "12345678000199",
  "businessName": "12.345.678 CAMILA OLIVEIRA",
  "tradingName": "Empresa Fictícia",
  "businessEmail": "[email protected]",
  "businessType": "MEI",
  "businessSize": "MEI",
  "businessAddress": {
    "addressLine": "Rua das Acácias",
    "zipCode": "04567890",
    "city": "Belo Horizonte",
    "state": "MG",
    "country": "BR",
    "neighborhood": "Savassi",
    "buildingNumber": "789",
    "complement": "Sala 2"
  },
  "declaredAnnualBilling": "MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSAND",
  "documentNumberPersonal": "12345678900"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

Nome	Tipo	Descrição
`clientId`	`path`	Id do cliente. (Esse ID é fornecido junto com as credenciais do cliente)

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Campo	Tipo	Descrição	Especificação
`password`	string	Obrigatório. Senha de acesso	Deverá conter no mínimo 8 caracteres sendo composto por letras maiúsculas, letras minúsculas, números e caractere especial
`documentNumber`	string	Obrigatório. CNPJ da empresa
`businessName`	string	Obrigatório. Razão social da empresa.	Este campo não aceita caracteres especiais.
`tradingName`	string	Obrigatório. Nome fantasia da empresa.	Este campo não aceita caracteres especiais.
`businessEmail`	string	Obrigatório.. E-mail comercial da empresa.
`businessType`	string	Obrigatório. Tipo da empresa, que pode ser "MEI", "EI", "EIRELI" e "SLU".
`businessSize`	string	Obrigatório. Porte da empresa, que pode ser "MEI" (para empresas do tipo MEI), "ME" (para empresas do tipo EI, EIRELI e SLU) e "EPP" (para empresas do tipo EI e EIRELI).
`declaredAnnualBilling`	string	Obrigatório. Faixa de faturamento anual da empresa.
`documentNumberPersonal`	string	Obrigatório. CPF do Representante Legal	O Representante Legal deve ter uma conta aprovada
`businessAddress`	object	Obrigatório. Objeto que deverá conter informações sobre o endereço da empresa (registrado no cartão CNPJ).
`businessAddress.zipCode`	string	Obrigatório. Código postal do endereço.	Este campo não aceita caracteres especiais.
`businessAddress.addressLine`	string	Obrigatório. Logradouro (nome da rua, avenida etc.).
`businessAddress.buildingNumber`	string	Obrigatório. Número do imóvel com até 10 caracteres (se não existir, substitua por “S/N”).
`businessAddress.complement`	string	Complemento do endereço. Exemplo: Apto 123, Casa B etc.
`businessAddress.neighborhood`	string	Obrigatório. Nome do bairro ou distrito.
`businessAddress.city`	string	Obrigatório. Nome da cidade.
`businessAddress.state`	string	Obrigatório. Sigla do estado brasileiro.	Formato ISO 3166-2:BR. Exemplo: MG.
`businessAddress.country`	string	Obrigatório. Sigla do país (Brasil).	Formato ISO 3166-2:BR. Exemplo: BR.

{
  "password": "TesteFicticio123@",
  "documentNumber": "12345678000199",
  "businessName": "12.345.678 CAMILA OLIVEIRA",
  "tradingName": "Empresa Fictícia",
  "businessEmail": "[email protected]",
  "businessType": "MEI",
  "businessSize": "MEI",
  "declaredAnnualBilling": "MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSAND",
  "documentNumberPersonal": "12345678900",
  "businessAddress": {
    "addressLine": "Rua das Acácias",
    "zipCode": "04567890",
    "city": "Belo Horizonte",
    "state": "MG",
    "country": "BR",
    "neighborhood": "Savassi",
    "buildingNumber": "789",
    "complement": "Sala 2"
  }
}

Resposta (Response)

O status code 202 indicará o sucesso no envio das informações.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
409	BUSINESS_AWAIT_EVALUATION	Business await evaluation.	O registro da empresa está sendo avaliado (status PENDING_APPROVAL).
409	BUSINESS_REGISTRATION_CANNOT_BE_REPLACED	Business registration has already been approved or still being analyzed. Consider update register using PATCH if is already approved.	O registro da empresa já foi aprovado.
422	INVALID_OCCUPATION	Occupation provided is invalid.	A ocupação informada é inválida.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook.

Nome do evento	Descrição
BUSINESS_WAS_RECEIVED	A solicitação de cadastro do cliente foi recebida.
BUSINESS_WAS_APPROVED	O cadastro do cliente foi aprovado.
BUSINESS_WAS_REPROVED	O cadastro do cliente foi reprovado.