Consulta do registro da empresa

Este endpoint retorna os dados de registro de uma empresa.

Requisição (Request)

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/business/{documentNumber}?resultLevel={resultLevel}'

--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/business/34183937000161?resultLevel=BASIC' \
--header 'accept: application/json' \
--header 'api-version: 1'

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.read`	Concede acesso para consultar o registro de qualquer tipo de cliente pessoa jurídica.

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 os seguintes campos:

Nome	Tipo	Descrição	Especificação
`documentNumber`	`path`	Obrigatório. Número do documento CNPJ da empresa.	Informe somente os números.
`resultLevel`	`query`	Tipo de consulta: BASIC (resultado resumido) ou DETAILED (resultado detalhado).	—

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento da pessoa jurídica.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento (nesse caso, "CNPJ").
`businessName`	`string`	Razão social da empresa.
`tradingName`	`string`	Nome fantasia da empresa.
`businessEmail`	`string`	E-mail comercial da empresa.
`businessType`	`string`	Tipo da empresa (MEI, EI, EIRELI, SLU, LTDA, S.A. e TS).
`businessSize`	`string`	Porte da empresa (MEI, ME, EPP, SMALL, MEDIUM, LARGE).
`businessAddress`	`object`	Endereço da empresa informado no registro.
`businessAddress.zipCode`	`string`	Código postal do endereço.
`businessAddress.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`businessAddress.buildingNumber`	`string`	Número do imóvel.
`businessAddress.complement`	`string`	Complemento do endereço. Exemplo: Apto 123, Casa B etc.
`businessAddress.neighborhood`	`string`	Nome do bairro ou distrito.
`businessAddress.city`	`string`	Nome da cidade.
`businessAddress.state`	`string`	Sigla do estado brasileiro conforme a ISO 3166-2:BR.
`businessAddress.country`	`string`	Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR.
`status`	`string`	Status da análise KYC realizada no registro da empresa, o qual pode ser PENDING_APPROVAL (registro em análise), APPROVED (aprovado), REPROVED (reprovado), REVOKED (revogado), CANCELED (cancelado) e BLACKLISTED (bloqueado).
`declaredAnnualBilling`	`string`	Faixa de faturamento anual da empresa.
`confirmedAnnualBilling`	`boolean`	Indica se o valor de faturamento informado foi confirmado no Bureau de informação.
`owners[]`	`array of objects`	Objeto que contém a lista de sócios da empresa como consta no Quadro dos Sócios e Administradores (QSA). Somente retornado para clientes do tipo LTDA / S.A. / TS.
`owners[].document`	`object`	Objeto que contém informações sobre o documento do cliente.
`owners[].document.value`	`string`	Número do documento.
`owners[].document.type`	`string`	Tipo do documento (CPF).
`owners[].registerName`	`string`	Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`owners[].socialName`	`string`	Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
`owners[].phone`	`object`	Objeto que contém informações sobre o telefone da pessoa.
`owners[].phone.countryCode`	`string`	Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
`owners[].phone.number`	`string`	Número de telefone incluindo o DDD.
`owners[].address`	`object`	Objeto que contém informações sobre o endereço da pessoa.
`owners[].address.zipCode`	`string`	Código postal correspondente ao endereço.
`owners[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`owners[].address.buildingNumber`	`string`	Número do imóvel.
`owners[].address.complement`	`string`	Complemento do endereço.
`owners[].address.neighborhood`	`string`	Nome do bairro ou distrito.
`owners[].address.city`	`string`	Nome da cidade.
`owners[].address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
`owners[].address.country`	`string`	Sigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
`owners[].birthDate`	`string`	Data de nascimento no formato YYYY-MM-DD, de acordo com a ISO 8601. Exemplo: 1810-10-12.
`owners[].motherName`	`string`	Nome da mãe do sócio, conforme consta no documento de identificação.
`owners[].email`	`string`	Endereço de e-mail.
`owners[].participationPercentage`	`string`	Percentual de participação (0 a 100).
`owners[].tradingName`	`string`	Nome fantasia da empresa (apenas para sócio pessoa jurídica).
`owners[].businessName`	`string`	Razão social da empresa (apenas para sócio pessoa jurídica)
`owners[].businessType`	`string`	Tipo da empresa do sócio pessoa jurídica, a qual pode ser MEI, EI, EIRELI, SLU, LTDA, SA e TS.
`owners[].declaredIncome`	`string`	Faixa de renda declarada pelo sócio.
`owners[].confirmedIncome`	`boolean`	Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é null.
`owners[].occupation`	`string`	Código de ocupação do cliente.
`owners[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do cliente.
`owners[].pep.level`	`string`	Nível de vínculo com a pessoa politicamente exposta, atendendo a Circular nº 3.978, o qual pode ser "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).
`owners[].pep.verified`	`boolean`	Indica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é false.
`owners[].documentation`	`object`	Objeto que contém as referências dos documentos enviados para análise.
`owners[].documentation.selfie`	`string`	Token da análise da selfie, retornado no endpoint de Envio e análise de documentos pessoais.
`owners[].documentation.idCardFront`	`string`	Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
`owners[].documentation.idCardBack`	`string`	Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
`legalRepresentatives[]`	`array of objects`	Lista de objetos contendo informações sobre os representantes legais da empresa.
`legalRepresentatives[].document`	`object`	Objeto que contém informações sobre o documento do representante legal.
`legalRepresentatives[].document.value`	`string`	Número do documento.
`legalRepresentatives[].document.type`	`string`	Tipo do documento (CPF).
`legalRepresentatives[].registerName`	`string`	Nome do representante legal, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`legalRepresentatives[].socialName`	`string`	Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
`legalRepresentatives[].phone`	`object`	Objeto que contém informações sobre o telefone do representante legal.
`legalRepresentatives[].phone.countryCode`	`string`	Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
`legalRepresentatives[].phone.number`	`string`	Número de telefone incluindo o DDD.
`legalRepresentatives[].address.zipCode`	`string`	Código postal correspondente ao do representante legal.
`legalRepresentatives[].address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`legalRepresentatives[].address.buildingNumber`	`string`	Número do imóvel com até 10 caracteres.
`legalRepresentatives[].address.complement`	`string`	Complemento do endereço. Exemplo: Apto 123, Casa B etc.
`legalRepresentatives[].address.neighborhood`	`string`	Nome do bairro ou distrito.
`legalRepresentatives[].address.city`	`string`	Nome da cidade.
`legalRepresentatives[].address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
`legalRepresentatives[].address.country`	`string`	Sigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
`legalRepresentatives[].birthDate`	`string`	Data de nascimento do representante legal, no formato YYYY-MM-DD, de acordo com a ISO 8601. Exemplo: 1810-10-12.
`legalRepresentatives[].motherName`	`string`	Nome da mãe do representante legal, conforme consta no documento de identificação.
`legalRepresentatives[].email`	`string`	Endereço de e-mail.
`legalRepresentatives[].declaredIncome`	`string`	Faixa de renda declarada pelo representante.
`legalRepresentatives[].confirmedIncome`	`string`	Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é null.
`legalRepresentatives[].occupation`	`string`	Código de ocupação do cliente.
`legalRepresentatives[].pep`	`object`	Objeto que contém informações sobre o nível de exposição política do cliente.
`legalRepresentatives[].pep.level`	`string`	Nível de vínculo com a pessoa politicamente exposta, atendendo a Circular nº 3.978, o qual pode ser "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).
`legalRepresentatives[].pep.verified`	`boolean`	Indica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor padrão desse campo é false.
`legalRepresentatives[].documentation`	`object`	Objeto que contém as referências dos documentos enviados para análise.
`legalRepresentatives[].documentation.selfie`	`string`	Token da análise da selfie, retornado no endpoint de Envio e análise de documentos pessoais.
`legalRepresentatives[].documentation.idCardFront`	`string`	Token da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
`legalRepresentatives[].documentation.idCardBack`	`string`	Token da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
`createdAt`	`string`	Data do primeiro registro da empresa, no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data da atualização do registro da empresa, no formato ISO 8601 - UTC.
`cnaeCode`	`string`	Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
`legalNature`	`string`	Natureza jurídica da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
`openingDate`	`string`	Data de abertura da empresa, no formato ISO 8601 - UTC. Somente retornado para clientes do tipo LTDA / S.A. / TS.
`phone`	`object`	Objeto que contém informações sobre o telefone da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
`phone.number`	`string`	Número de telefone incluindo o DDD.
`phone.countryCode`	`string`	Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
`reasons[]`	`array of strings`	Motivos de reprovação do registro da empresa (quando é o caso).

{
    "documentNumber": "34183937000161",
    "document": {
      "value": "34183937000161",
      "type": "CNPJ"
    },
    "businessName": "Editora Nísia Floresta",
    "tradingName": "Editora Floresta",
    "businessEmail": "[email protected]",
    "businessType": "MEI",
    "businessSize": "MEI",
    "businessAddress": {
      "zipCode": "68060100",
      "addressLine": "Rua 6 de Março",
      "buildingNumber": "2500",
      "complement": "",
      "neighborhood": "Alter do Chão",
      "city": "Santarém",
      "state": "PA",
      "country": "BR"
    },
    "status": "PENDING_APPROVAL",
    "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
    "confirmedAnnualBilling": "true",
    "legalRepresentatives": [
      {
        "documentNumber": "47742663023",
        "document": {
          "value": "47742663023",
          "type": "CPF"
        },
        "registerName": "Nísia Floresta",
        "socialName": "Nísia Floresta",
        "phone": {
          "countryCode": "55",
          "number": "23415162342"
        },
        "address": {
          "zipCode": "68060100",
          "addressLine": "Rua 6 de Março",
          "buildingNumber": "2500",
          "complement": "",
          "neighborhood": "Alter do Chão",
          "city": "Santarém",
          "state": "PA",
          "country": "BR"
        },
        "birthDate": "1810-10-12T19:31:44.436Z",
        "motherName": "Dionísia Gonçalves Pinto",
        "email": "[email protected]",
        "declaredIncome": "LESS_THAN_ONE_THOUSAND",
        "confirmedIncome": "",
        "occupation": "OCP0001",
        "pep": {
          "level": "NONE",
          "verified": true
        },
        "documentation": {
          "selfie": "ce1849509a3f4625867ead5768d5b068",
          "idCardFront": "9c1974193d96446e84833742aed1db62",
          "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
        }
      }
    ],
    "createdAt": "2022-12-29T19:31:44.436Z",
    "updatedAt": "2022-12-29T19:31:44.436Z"
}

{
  "documentNumber": "34183937000161",
  "document": {
    "value": "34183937000161",
    "type": "CNPJ"
    },
  "businessName": "Editora Nísia Floresta",
  "tradingName": "Editora Floresta",
  "businessEmail": "[email protected]",
  "businessType": "TS",
  "businessSize": "SMALL",
  "businessAddress": {
    "zipCode": "68060100",
    "addressLine": "Rua 6 de Março",
    "buildingNumber": "2500",
    "complement": "",
    "neighborhood": "Alter do Chão",
    "city": "Santarém",
    "state": "PA",
    "country": "BR" 
  },
  "status": "PENDING_APPROVAL",
  "declaredAnnualBilling": "UP_TO_FIFTY_THOUSAND",
  "confirmedAnnualBilling": true,
  "owners": [
    {
      "documentNumber": "09992220074",
      "document": {
        "value": "09992220074",
        "type": "CPF"
      },
      "registerName": "Maria Quitéria de Jesus",
      "socialName": "",
      "phone": {
        "countryCode": "55",
        "number": "23415162342"
      },
      "address": {
        "zipCode": "44001120",
        "addressLine": "R. Prof. Geminiano Costa",
        "buildingNumber": "25500",
        "complement": "",
        "neighborhood": "Centro",
        "city": "Feira de Santana",
        "state": "BA",
        "country": "BR"
      },
      "birthDate": "1988-05-06T19:31:44.436Z",
      "motherName": "Maria de Jesus",
      "email": "[email protected]",
      "participationPercentage": "50",
      "tradingName": "Maria Edições",
      "businessName": "MQJ Edições",
      "businessType": "MEI",
      "declaredIncome": "FROM_TWO_THOUSAND_TO_THREE_THOUSAND",
      "confirmedIncome": true,
      "occupation": "OCP0001",
      "pep": {
        "level": "NONE",
        "verified": true
      },
      "documentation": {
        "selfie": "ce1849509a3f4625867ead5768d5b068",
        "idCardFront": "9c1974193d96446e84833742aed1db62",
        "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
      }
    }
  ],
  "legalRepresentatives": [
    {
      "documentNumber": "47742663023",
      "document": {
        "value": "47742663023",
        "type": "CPF"
      },
      "registerName": "Nísia Floresta",
      "socialName": "Nísia Floresta",
      "phone": {
        "countryCode": "55",
        "number": "23415162342"
      },
      "address": {
        "zipCode": "68060100",
        "addressLine": "Rua 6 de Março",
        "buildingNumber": "2500",
        "complement": "",
        "neighborhood": "Alter do Chão",
        "city": "Santarém",
        "state": "PA",
        "country": "BR"
      },
      "birthDate": "1810-10-12T19:31:44.436Z",
      "motherName": "Dionísia Gonçalves Pinto",
      "email": "[email protected]",
      "declaredIncome": "LESS_THAN_ONE_THOUSAND",
      "confirmedIncome": "",
      "occupation": "OCP0001",
      "pep": {
        "level": "NONE",
        "verified": true
      },
      "documentation": {
        "selfie": "ce1849509a3f4625867ead5768d5b068",
        "idCardFront": "9c1974193d96446e84833742aed1db62",
        "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
      }
    }
  ],
  "createdAt": "2022-12-29T19:31:44.436Z",
  "updatedAt": "2022-12-29T19:31:44.436Z",
  "cnaeCode": "99-1",
  "legalNature": "123-4",
  "openingDate": "2022-12-29T19:31:44.436Z",
  "phone": {
    "countryCode": "55",
    "number": "23415162342"
  },
  "reasons": [
    "`string`"
  ]
}

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.
NOT_DECLARED	Não declarada.
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.

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

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍Dica

Erros

Eventos

👍
Dica