InstitucionalBlogService DeskStatus Page

Consulta do registro da empresa

stable

Suggest Edits

Este endpoint retorna os dados de registro de uma empresa.

Requisição

Requisição HTTP

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

curl --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:

ScopeDescrição
business.readConcede acesso para consultar o registro de qualquer tipo de cliente pessoa jurídica.

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

NomeTipoDescrição
documentNumberpathObrigatório. Número do documento CNPJ da empresa. Informe somente os números.
resultLevelqueryTipo 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:

NomeTipoDescrição
documentNumberstringNúmero do documento CNPJ da empresa. (Obsoleto. Utilize o campo document.value).
documentobjectObjeto que contém informações sobre o documento da pessoa jurídica.
document.valuestringNúmero do documento.
document.typestringTipo do documento (nesse caso, "CNPJ").
businessNamestringRazão social da empresa.
tradingNamestringNome fantasia da empresa.
businessEmailstringE-mail comercial da empresa.
businessTypestringTipo da empresa (MEI, EI, EIRELI, SLU, LTDA, S.A. e TS).
businessSizestringPorte da empresa (MEI, ME, EPP, SMALL, MEDIUM, LARGE).
businessAddressobjectEndereço da empresa informado no registro.
businessAddress.zipCodestringCódigo postal do endereço.
businessAddress.addressLinestringLogradouro (nome da rua, avenida etc.).
businessAddress.buildingNumberstringNúmero do imóvel.
businessAddress.complementstringComplemento do endereço. Exemplo: Apto 123, Casa B etc.
businessAddress.neighborhoodstringNome do bairro ou distrito.
businessAddress.citystringNome da cidade.
businessAddress.statestringSigla do estado brasileiro conforme a ISO 3166-2:BR.
businessAddress.countrystringSigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR.
statusstringStatus 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).
declaredAnnualBillingstringFaixa de faturamento anual da empresa, descrito na tabela de faturamento anual.
confirmedAnnualBillingbooleanIndica se o valor de faturamento informado foi confirmado no Bureau de informação.
owners[]array of objectsObjeto 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[].documentNumberstringNúmero do documento CPF do cliente. (Obsoleto. Utilize o campo document.value).
owners[].documentobjectObjeto que contém informações sobre o documento do cliente.
owners[].document.valuestringNúmero do documento.
owners[].document.typestringTipo do documento (CPF).
owners[].registerNamestringNome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
owners[].socialNamestringNome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
owners[].phoneobjectObjeto que contém os dados referentes ao telefone da pessoa.
owners[].phone.countryCodestringCódigo DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
owners[].phone.numberstringNúmero de telefone incluindo o DDD.
owners[].addressobjectObjeto que contém os dados referente o endereço da pessoa.
owners[].address.zipCodestringCódigo postal correspondente ao endereço.
owners[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
owners[].address.buildingNumberstringNúmero do imóvel.
owners[].address.complementstringComplemento do endereço.
owners[].address.neighborhoodstringNome do bairro ou distrito.
owners[].address.citystringNome da cidade.
owners[].address.statestringSigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
owners[].address.countrystringSigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
owners[].birthDatestringData de nascimento no formato YYYY-MM-DD, de acordo com a ISO 8601. Exemplo: 1810-10-12.
owners[].motherNamestringNome da mãe do sócio, conforme consta no documento de identificação.
owners[].emailstringEndereço de e-mail.
owners[].participationPercentagestringPercentual de participação (0 a 100).
owners[].tradingNamestringNome fantasia da empresa (apenas para sócio pessoa jurídica).
owners[].businessNamestringRazão social da empresa (apenas para sócio pessoa jurídica)
owners[].businessTypestringTipo da empresa do sócio pessoa jurídica, a qual pode ser MEI, EI, EIRELI, SLU, LTDA, SA e TS.
owners[].declaredIncomestringFaixa de renda declarada pelo sócio, descrito na tabela de renda declarada.
owners[].confirmedIncomebooleanIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é null.
owners[].occupationstringCódigo de ocupação do cliente. 
owners[].pepobjectObjeto que contém informações sobre o nível de exposição política do cliente.
owners[].pep.levelstringNí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.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor default desse campo é false.
owners[].documentationobjectObjeto que contém as referências dos documentos enviados para análise.
owners[].documentation.selfiestringToken da análise da selfie, retornado no endpoint de Envio e análise de documentos pessoais.
owners[].documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
owners[].documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
`legalRepresentatives[]array of objectsObjeto que contém a lista de representantes legais da empresa.
legalRepresentatives[].documentNumberstringNúmero do documento CPF do cliente. (Obsoleto. Utilize o campo document.value).
legalRepresentatives[].documentobjectObjeto que contém informações sobre o documento do cliente.
legalRepresentatives[].document.valuestringNúmero do documento.
legalRepresentatives[].document.typestringTipo do documento (CPF).
legalRepresentatives[].registerNamestringNome do representante legal, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
legalRepresentatives[].socialNamestringNome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
legalRepresentatives[].phoneobjectObjeto que contém os dados referente ao telefone do representante legal.
legalRepresentatives[].phone.countryCodestringCódigo DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
legalRepresentatives[].phone.numberstringNúmero de telefone incluindo o DDD.
legalRepresentatives[].address.zipCodestringCódigo postal correspondente ao do representante legal.
legalRepresentatives[].address.addressLinestringLogradouro (nome da rua, avenida etc.).
legalRepresentatives[].address.buildingNumberstringNúmero do imóvel com até 10 caracteres.
legalRepresentatives[].address.complementstringComplemento do endereço. Exemplo: Apto 123, Casa B etc.
legalRepresentatives[].address.neighborhoodstringNome do bairro ou distrito.
legalRepresentatives[].address.citystringNome da cidade.
legalRepresentatives[].address.statestringSigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: MG.
legalRepresentatives[].address.countrystringSigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.
legalRepresentatives[].birthDatestringData de nascimento do representante legal, no formato YYYY-MM-DD, de acordo com a ISO 8601. Exemplo: 1810-10-12.
legalRepresentatives[].motherNamestringNome da mãe do representante legal, conforme consta no documento de identificação.
legalRepresentatives[].emailstringEndereço de e-mail.
legalRepresentatives[].declaredIncomestringFaixa de renda declarada pelo representante legal, descrito na tabela de renda declarada.
legalRepresentatives[].confirmedIncomestringIndica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é null.
legalRepresentatives[].occupationstringCódigo de ocupação do cliente.
legalRepresentatives[].pepobjectObjeto que contém informações sobre o nível de exposição política do cliente.
legalRepresentatives[].pep.levelstringNí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.verifiedbooleanIndica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor default desse campo é false.
legalRepresentatives[].documentationobjectObjeto que contém as referências dos documentos enviados para análise.
legalRepresentatives[].documentation.selfiestringToken da análise da selfie, retornado no endpoint de Envio e análise de documentos pessoais.
legalRepresentatives[].documentation.idCardFrontstringToken da análise da frente do documento, retornado no endpoint de Envio e análise de documentos pessoais.
legalRepresentatives[].documentation.idCardBackstringToken da análise do verso do documento, retornado no endpoint de Envio e análise de documentos pessoais.
createdAtstringData do primeiro registro da empresa, no formato ISO 8601 - UTC.
updatedAtstringData da atualização do registro da empresa, no formato ISO 8601 - UTC.
cnaeCodestringCódigo CNAE (Classificação Nacional de Atividades Econômicas) da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
legalNaturestringNatureza jurídica da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
openingDatestringData de abertura da empresa, no formato ISO 8601 - UTC. Somente retornado para clientes do tipo LTDA / S.A. / TS.
phoneobjectObjeto que contém os dados referentes ao telefone da empresa. Somente retornado para clientes do tipo LTDA / S.A. / TS.
phone.numberstringNúmero de telefone incluindo o DDD.
phone.countryCodestringCódigo DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
reasons[]array of stringsMotivos 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

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

👍

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.

Updated 13 days ago