Registro de MEI, EI, EIRELI ou SLU

Este endpoint permite realizar o registro de clientes pessoa jurídica do tipo MEI, EI, EIRELI ou SLU.

Pré-requisitos

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

A selfie e as fotos (frente e verso) do documento tenham sido enviadas para análise por meio do endpoint Envio e análise de documentos pessoais;
A selfie e as fotos (frente e verso) do documento tenham sido aprovadas.

❗
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

Requisição HTTP

PUT https://api-mtls.sandbox.bankly.com.br/business/{documentNumber}

curl --request PUT \
     --url https://api-mtls.sandbox.bankly.com.br/business/34183937000161 \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'content-type: application/json' \
     --data '{
     "businessName": "Editora Floresta",
     "tradingName": "Editora Nísia Floresta",
     "businessEmail": "[email protected]",
     "`businessType`": "EIRELI",
     "`businessSize`": "EPP",
     "`declaredAnnualBilling`": "EXEMPT_COMPANY",
     "businessAddress": {
          "zipCode": "68060100",
          "addressLine": "Rua 6 de Março",
          "buildingNumber": "2500",
          "city": "Santarém",
          "state": "PA",
          "neighborhood": "Alter do Chão",
          "country": "BR"
     },
     "legalRepresentative": {
          "registerName": "Nísia Floresta",
          "documentNumber": "47742663023",
          "birthDate": "1810-10-12",
          "motherName": "Dionísia Gonçalves Pinto",
          "email": "[email protected]",
          "declaredIncome": "FROM_TEN_THOUSAND_TO_TWENTY_THOUSAND",
          "occupation": "OCP0001",
          "document": {
               "value": "47742663023",
               "type": "CPF"
          },
          "phone": {
               "countryCode": "55",
               "`number`": "23415162342"
          },
          "address": {
               "zipCode": "68060100",
               "addressLine": "Rua 6 de Março",
               "buildingNumber": "2500",
               "neighborhood": "Alter do Chão",
               "city": "Santarém",
               "state": "PA",
               "country": "BR"
          },
          "pep": {
               "level": "NONE"
          },
          "documentation": {
               "selfie": "ce1849509a3f4625867ead5768d5b068",
               "idCardFront": "9c1974193d96446e84833742aed1db62",
               "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
          }
     }     
}
'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`business.write`	Concede acesso para criar ou atualizar o registro de um cliente pessoa jurídica do tipo MEI, EI, EIRELI ou SLU.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`documentNumber`	`path`	Obrigatório. Número do documento CNPJ da empresa. Informe somente os números.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`businessName`	`string`	Obrigatório. Razão social da empresa. Importante: este campo não aceita caracteres especiais.
`tradingName`	`string`	Nome fantasia da empresa. Importante: 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, descrito na tabela de faturamento anual.
`businessAddress`	`object`	Obrigatório. Objeto que contém os dados do endereço da empresa (registrado no cartão CNPJ).
`businessAddress.zipCode`	`string`	Obrigatório. Código postal do endereço sem formatação.
`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 conforme a ISO 3166-2:BR. Exemplo: MG.
`businessAddress.country`	`string`	Obrigatório. Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR.
`legalRepresentative`	`object`	Obrigatório. Objeto que contém os dados do representante legal da empresa.
`legalRepresentative.registerName`	`string`	Obrigatório. Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM), sem abreviações e sem caracteres especiais.
`legalRepresentative.socialName`	`string`	Nome social, ou seja, a forma pela qual o cliente gostaria de ser chamado, sem caracteres especiais.
`legalRepresentative.birthDate`	`string`	Obrigatório. Data de nascimento do representante legal no formato ISO 8601 - UTC.
`legalRepresentative.motherName`	`string`	Obrigatório. Nome da mãe do representante legal conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM), sem abreviações. Também é possível incluir o nome que consta no campo Filiação dos documentos de identificação.
`legalRepresentative.email`	`string`	Obrigatório. Endereço de e-mail.
`legalRepresentative.declaredIncome`	`string`	Obrigatório. Faixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
`legalRepresentative.ocupation`	`string`	Obrigatório. Código de ocupação do cliente. Caso o cliente possua mais de uma ocupação, esse campo deve ser preenchido com a sua principal fonte de renda.
`legalRepresentative.documentNumber`	`string`	Número do documento CPF do representante legal. (Obsoleto. Utilize o campo `document.value`).
`legalRepresentative.document`	`object`	Obrigatório. Objeto que contém informações sobre o documento do cliente.
`legalRepresentative.document.value`	`string`	Obrigatório. Número do documento. Informe somente números.
`legalRepresentative.document.type`	`string`	Obrigatório. Tipo do documento (CPF).
`legalRepresentative.phone`	`object`	Obrigatório. Objeto que contém os dados referente ao telefone do representante legal.
`legalRepresentative.phone.countryCode`	`string`	Obrigatório. Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
`legalRepresentative.phone.number`	`string`	Obrigatório. Número de telefone incluindo o DDD.
`legalRepresentative.address`	`object`	Obrigatório. Objeto que contém os dados referentes ao endereço do representante legal.
`legalRepresentative.address.zipCode`	`string`	Obrigatório. Código postal do endereço, sem formatação.
`legalRepresentative.address.addressLine`	`string`	Obrigatório. Logradouro (nome da rua, avenida etc.).
`legalRepresentative.address.buildingNumber`	`string`	Obrigatório. Número do imóvel com até 10 caracteres (se não existir, substitua por “S/N”).
`legalRepresentative.address.complement`	`string`	Complemento do endereço. Exemplo: Apto 123, Casa B etc.
`legalRepresentative.address.neighborhood`	`string`	Obrigatório. Nome do bairro ou distrito.
`legalRepresentative.address.city`	`string`	Obrigatório. Nome da cidade.
`legalRepresentative.address.state`	`string`	Obrigatório. Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
`legalRepresentative.address.country`	`string`	Obrigatório. Sigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
`legalRepresentative.pep`	`object`	Obrigatório. Objeto onde deve ser informado o nível de exposição política do cliente, atendendo à Circular nº 3.978.
`legalRepresentative.pep.level`	`string`	Obrigatório. Nível de exposição política do cliente: "NONE" (o cliente não é e nem tem vínculo com pessoa exposta politicamente), "SELF" (o cliente é pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de pessoa exposta politicamente).
`legalRepresentative.documentation`	`object`	Obrigatório. Objeto onde devem ser informadas as referências dos documentos do cliente que foram enviados para análise. Essas referências são retornadas no endpoint de Envio e análise de documentos pessoais.
`legalRepresentative.documentation.selfie`	`string`	Obrigatório. Token retornado na análise da Selfie.
`legalRepresentative.documentation.idCardFront`	`string`	Obrigatório. Token retornado na análise da frente do documento.
`legalRepresentative.documentation.idCardBack`	`string`	Obrigatório. Token retornado na análise do verso do documento.

{
     "businessName": "Editora Floresta",
     "tradingName": "Editora Nísia Floresta",
     "businessEmail": "[email protected]",
     "businessType": "EIRELI",
     "businessSize": "EPP",
     "declaredAnnualBilling": "EXEMPT_COMPANY",
     "businessAddress": {
          "zipCode": "68060100",
          "addressLine": "Rua 6 de Março",
          "buildingNumber": "2500",
          "city": "Santarém",
          "state": "PA",
          "neighborhood": "Alter do Chão",
          "country": "BR"
     },
     "legalRepresentative": {
          "registerName": "Nísia Floresta",
          "documentNumber": "47742663023",
          "birthDate": "1810-10-12",
          "motherName": "Dionísia Gonçalves Pinto",
          "email": "[email protected]",
          "declaredIncome": "FROM_TEN_THOUSAND_TO_TWENTY_THOUSAND",
          "occupation": "OCP0001",
          "document": {
               "value": "47742663023",
               "type": "CPF"
          },
          "phone": {
               "countryCode": "55",
               "`number`": "23415162342"
          },
          "address": {
               "zipCode": "68060100",
               "addressLine": "Rua 6 de Março",
               "buildingNumber": "2500",
               "neighborhood": "Alter do Chão",
               "city": "Santarém",
               "state": "PA",
               "country": "BR"
          },
          "pep": {
               "level": "NONE"
          },
          "documentation": {
               "selfie": "ce1849509a3f4625867ead5768d5b068",
               "idCardFront": "9c1974193d96446e84833742aed1db62",
               "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
          }
     }
}

Faixa de faturamento anual da empresa

Faturamento	Descrição
UP_TO_FIFTY_THOUSAND	Até 50 mil.
MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSAND	De 50 mil a 100 mil.
MORE_THAN_ONE_HUNDRED_THOUSAND_UP_TO_TWO_HUNDRED_AND_FIFTY_THOUSAND	De 100 mil a 250 mil.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_THOUSAND_UP_TO_FIVE_HUNDRED_THOUSAND	De 250 mil a 500 mil.
MORE_THAN_FIVE_HUNDRED_THOUSAND_UP_TO_ONE_MILLION	De 500 mil a 1 milhão.
MORE_THAN_ONE_MILLION_UP_TO_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND	De 1 milhão a 2 milhões e 500 mil.
MORE_THAN_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND_UP_TO_FIVE_MILLION	De 2 milhões e 500 mil a 5 milhões.
MORE_THAN_FIVE_MILLION_UP_TO_TEN_MILLION	De 5 milhões a 10 milhões.
MORE_THAN_TEN_MILLION_UP_TO_TWENTY_FIVE_MILLION	De 10 milhões a 25 milhões.
MORE_THAN_TWENTY_FIVE_MILLION_UP_TO_FIFTY_MILLION	De 25 milhões a 50 milhões.
MORE_THAN_FIFTY_MILLION_UP_TO_ONE_HUNDRED_MILLION	De 50 milhões a 100 milhões.
MORE_THAN_ONE_HUNDRED_MILLION_UP_TO_TWO_HUNDRED_AND_FIFTY_MILLION	De 100 milhões a 250 milhões.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_MILLION_UP_TO_FIVE_HUNDRED_MILLION	De 250 milhões a 500 milhões.
MORE_THAN_FIVE_HUNDRED_MILLION	Mais de 500 milhões.
EXEMPT_COMPANY	Empresa isenta.
INACTIVE_COMPANY	Empresa inativa.

Faixa de renda declarada

Faturamento	Descrição
LESS_THAN_ONE_THOUSAND	Inferior a mil.
FROM_ONE_THOUSAND_TO_TWO_THOUSAND	De mil a dois mil.
FROM_TWO_THOUSAND_TO_THREE_THOUSAND	De 2 mil a 3 mil.
FROM_THREE_THOUSAND_TO_FIVE_THOUSAND	De 3 mil a 5 mil.
FROM_FIVE_THOUSAND_TO_TEN_THOUSAND	De 5 mil a 10 mil.
FROM_TEN_THOUSAND_TO_TWENTY_THOUSAND	De 10 mil a 20 mil.
OVER_TWENTY_THOUSAND	Acima de 20 mil.

Resposta (Response)

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

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

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. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês 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.

Registro de MEI, EI, EIRELI ou SLU

Pré-requisitos

❗
Atenção

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍
Dica

Erros

Eventos

Pré-requisitos

❗Atenção

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍Dica

Erros

Eventos

❗
Atenção

👍
Dica