Registro de MEI, EI, EIRELI ou SLU

stable

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:

ScopeDescrição
business.writeConcede acesso para criar ou atualizar o registro de um cliente pessoa jurídica do tipo MEI, EI, EIRELI ou SLU.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
documentNumberpathObrigató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:

NomeTipoDescrição
businessNamestringObrigatório. Razão social da empresa. Importante: este campo não aceita caracteres especiais.
tradingNamestringNome fantasia da empresa. Importante: este campo não aceita caracteres especiais.
businessEmailstringObrigatório. E-mail comercial da empresa.
businessTypestringObrigatório. Tipo da empresa, que pode ser MEI, EI, EIRELI e SLU.
businessSizestringObrigató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).
declaredAnnualBillingstringObrigatório. Faixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
businessAddressobjectObrigatório. Objeto que contém os dados do endereço da empresa (registrado no cartão CNPJ).
businessAddress.zipCodestringObrigatório. Código postal do endereço sem formatação.
businessAddress.addressLinestringObrigatório. Logradouro (nome da rua, avenida etc.).
businessAddress.buildingNumberstringObrigatório. Número do imóvel com até 10 caracteres (se não existir, substitua por “S/N”).
businessAddress.complementstringComplemento do endereço. Exemplo: Apto 123, Casa B etc.
businessAddress.neighborhoodstringObrigatório. Nome do bairro ou distrito.
businessAddress.citystringObrigatório. Nome da cidade.
businessAddress.statestringObrigatório. Sigla do estado brasileiro conforme a ISO 3166-2:BR. Exemplo: MG.
businessAddress.countrystringObrigatório. Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR.
legalRepresentativeobjectObrigatório. Objeto que contém os dados do representante legal da empresa.
legalRepresentative.registerNamestringObrigatório. Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM), sem abreviações e sem caracteres especiais.
legalRepresentative.socialNamestringNome social, ou seja, a forma pela qual o cliente gostaria de ser chamado, sem caracteres especiais.
legalRepresentative.birthDatestringObrigatório. Data de nascimento do representante legal no formato YYYY-MM-DDTHH:mm:SS.
legalRepresentative.motherNamestringObrigató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.emailstringObrigatório. Endereço de e-mail.
legalRepresentative.declaredIncomestringObrigatório. Faixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
legalRepresentative.ocupationstringObrigató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.documentNumberstringNúmero do documento CPF do representante legal. (Obsoleto. Utilize o campo document.value).
legalRepresentative.documentobjectObrigatório. Objeto que contém informações sobre o documento do cliente.
legalRepresentative.document.valuestringObrigatório. Número do documento. Informe somente números.
legalRepresentative.document.typestringObrigatório. Tipo do documento (CPF).
legalRepresentative.phoneobjectObrigatório. Objeto que contém os dados referente ao telefone do representante legal.
legalRepresentative.phone.countryCodestringObrigatório. Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
legalRepresentative.phone.numberstringObrigatório. Número de telefone incluindo o DDD.
legalRepresentative.addressobjectObrigatório. Objeto que contém os dados referentes ao endereço do representante legal.
legalRepresentative.address.zipCodestringObrigatório. Código postal do endereço, sem formatação.
legalRepresentative.address.addressLinestringObrigatório. Logradouro (nome da rua, avenida etc.).
legalRepresentative.address.buildingNumberstringObrigatório. Número do imóvel com até 10 caracteres (se não existir, substitua por “S/N”).
legalRepresentative.address.complementstringComplemento do endereço. Exemplo: Apto 123, Casa B etc.
legalRepresentative.address.neighborhoodstringObrigatório. Nome do bairro ou distrito.
legalRepresentative.address.citystringObrigatório. Nome da cidade.
legalRepresentative.address.statestringObrigatório. Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
legalRepresentative.address.countrystringObrigatório. Sigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
legalRepresentative.pepobjectObrigatório. Objeto onde deve ser informado o nível de exposição política do cliente, atendendo à Circular nº 3.978.
legalRepresentative.pep.levelstringObrigató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.documentationobjectObrigató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.selfiestringObrigatório. Token retornado na análise da Selfie.
legalRepresentative.documentation.idCardFrontstringObrigatório. Token retornado na análise da frente do documento.
legalRepresentative.documentation.idCardBackstringObrigató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

FaturamentoDescrição
UP_TO_FIFTY_THOUSANDAté 50 mil.
MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSANDDe 50 mil a 100 mil.
MORE_THAN_ONE_HUNDRED_THOUSAND_UP_TO_TWO_HUNDRED_AND_FIFTY_THOUSANDDe 100 mil a 250 mil.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_THOUSAND_UP_TO_FIVE_HUNDRED_THOUSANDDe 250 mil a 500 mil.
MORE_THAN_FIVE_HUNDRED_THOUSAND_UP_TO_ONE_MILLIONDe 500 mil a 1 milhão.
MORE_THAN_ONE_MILLION_UP_TO_TWO_MILLION_AND_FIVE_HUNDRED_THOUSANDDe 1 milhão a 2 milhões e 500 mil.
MORE_THAN_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND_UP_TO_FIVE_MILLIONDe 2 milhões e 500 mil a 5 milhões.
MORE_THAN_FIVE_MILLION_UP_TO_TEN_MILLIONDe 5 milhões a 10 milhões.
MORE_THAN_TEN_MILLION_UP_TO_TWENTY_FIVE_MILLIONDe 10 milhões a 25 milhões.
MORE_THAN_TWENTY_FIVE_MILLION_UP_TO_FIFTY_MILLIONDe 25 milhões a 50 milhões.
MORE_THAN_FIFTY_MILLION_UP_TO_ONE_HUNDRED_MILLIONDe 50 milhões a 100 milhões.
MORE_THAN_ONE_HUNDRED_MILLION_UP_TO_TWO_HUNDRED_AND_FIFTY_MILLIONDe 100 milhões a 250 milhões.
MORE_THAN_TWO_HUNDRED_AND_FIFTY_MILLION_UP_TO_FIVE_HUNDRED_MILLIONDe 250 milhões a 500 milhões.
MORE_THAN_FIVE_HUNDRED_MILLIONMais de 500 milhões.
EXEMPT_COMPANYEmpresa isenta.
INACTIVE_COMPANYEmpresa inativa.

Faixa de renda declarada

FaturamentoDescrição
LESS_THAN_ONE_THOUSANDInferior a mil.
FROM_ONE_THOUSAND_TO_TWO_THOUSANDDe mil a dois mil.
FROM_TWO_THOUSAND_TO_THREE_THOUSANDDe 2 mil a 3 mil.
FROM_THREE_THOUSAND_TO_FIVE_THOUSANDDe 3 mil a 5 mil.
FROM_FIVE_THOUSAND_TO_TEN_THOUSANDDe 5 mil a 10 mil.
FROM_TEN_THOUSAND_TO_TWENTY_THOUSANDDe 10 mil a 20 mil.
OVER_TWENTY_THOUSANDAcima 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 CodeCódigoDescrição
409BUSINESS_AWAIT_EVALUATIONO registro da empresa está sendo avaliado (status PENDING_APPROVAL).
409BUSINESS_REGISTRATION_CANNOT_BE_REPLACEDO registro da empresa já foi aprovado.
422INVALID_OCCUPATIONA ocupação informada é inválida.

Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints. Além disso, por meio da página de erros comuns é possível saber quais mensagens em inglês os erros 400 (caso haja) podem retornar.

Eventos

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

Nome do eventoDescrição
BUSINESS_WAS_RECEIVEDA solicitação de cadastro do cliente foi recebida.