BAbankly
Pessoa jurídica

Consulta do registro da empresa

<div class="bkly-ref-description"> <p>Obtenha um resultado resumido (BASIC) ou detalhado (DETAILED) dos dados de registro de uma empresa.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: business.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta do registro da empresa](/docs/consulta-registro-empresa)." } [/block]
get/business/{documentNumber}

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/business/{documentNumber}
  • Auth
    HTTP bearer

Query parameters

resultLevel'BASIC' | 'DETAILED'

Tipo de retorno da API. (BASIC, DETAILED)

Tipo de retorno da API.

Parameters

#/paths/~1business~1{documentNumber}/put/parameters/0 (unresolved $ref)
#/paths/~1business~1{documentNumber}/put/parameters/1 (unresolved $ref)
#/paths/~1business~1{documentNumber}/put/parameters/2 (unresolved $ref)

Response

Recurso encontrado.

documentNumberstring

Número do documento CNPJ da empresa. (Obsoleto. Considere o campo <code>document.value</code>).

businessNamestring

Razão social da empresa.

tradingNamestring

Nome fantasia da empresa.

businessEmailstring email

<i>E-mail</i> comercial da empresa.

businessType'MEI' | 'EI' | 'EIRELI' | 'SLU' | 'LTDA' | 'SA' | 'TS'

Tipo da empresa.

businessSize'MEI' | 'ME' | 'EPP' | 'SMALL' | 'MEDIUM' | 'LARGE'

Porte da empresa.

status'PENDING_APPROVAL' | 'APPROVED' | 'IN_ANALYSIS' | 'REPROVED' | 'REVOKED' | 'CANCELED' | 'BLACKLISTED'

</i>Status</i> da análise KYC realizada no registro do cliente.

declaredAnnualBilling'UP_TO_FIFTY_THOUSAND' | 'MORE_THAN_FIFTY_THOUSAND_UP_TO_ONE_HUNDRED_THOUSAND' | 'MORE_THAN_ONE_HUNDRED_THOUSAND_UP_TO_TWO_HUNDRED_AND_FIFTY_THOUSAND' | 'MORE_THAN_TWO_HUNDRED_AND_FIFTY_THOUSAND_UP_TO_FIVE_HUNDRED_THOUSAND' | 'MORE_THAN_FIVE_HUNDRED_THOUSAND_UP_TO_ONE_MILLION' | 'MORE_THAN_ONE_MILLION_UP_TO_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND' | 'MORE_THAN_TWO_MILLION_AND_FIVE_HUNDRED_THOUSAND_UP_TO_FIVE_MILLION' | 'MORE_THAN_FIVE_MILLION_UP_TO_TEN_MILLION' | 'MORE_THAN_TEN_MILLION_UP_TO_TWENTY_FIVE_MILLION' | 'MORE_THAN_TWENTY_FIVE_MILLION_UP_TO_FIFTY_MILLION' | 'MORE_THAN_FIFTY_MILLION_UP_TO_ONE_HUNDRED_MILLION' | 'MORE_THAN_ONE_HUNDRED_MILLION_UP_TO_TWO_HUNDRED_AND_FIFTY_MILLION' | 'MORE_THAN_TWO_HUNDRED_AND_FIFTY_MILLION_UP_TO_FIVE_HUNDRED_MILLION' | 'MORE_THAN_FIVE_HUNDRED_MILLION' | 'EXEMPT_COMPANY' | 'NOT_DECLARED' | 'INACTIVE_COMPANY'

Faixa de faturamento anual da empresa.

confirmedAnnualBillingstring

Indica se o valor de faturamento informado foi confirmado no <i>Bureau</i> de informação.

createdAtstring date-time

Data do primeiro registro da empresa.

updatedAtstring date-time nullable

Data da atualização do registro da empresa.

cnaeCodestring nullable

Código CNAE (Classificação Nacional de Atividades Econômicas) da empresa. Somente retornado para clientes do tipo LTDA, S.A. e TS.

legalNaturestring nullable

Natureza jurídica da empresa. Somente retornado para clientes do tipo LTDA, S.A. e TS.

openingDatestring date-time

Data de abertura da empresa. Somente retornado para clientes do tipo LTDA, S.A. e TS.

reasonsstring[] nullable

Motivos de reprovação do registro da empresa (quando é o caso).

Changes

No recorded changes to this operation across all 1 revision of this API.