BAbankly
Pessoa física

Consulta do registro do cliente

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

Request

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

Parameters

#/paths/~1customers~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)
#/paths/~1business~1{documentNumber}/get/parameters/2 (unresolved $ref)

Response

Recurso encontrado.

documentNumberstring

Número do documento CPF do cliente. (<b>Obsoleto</b>. Considere o campo <code>document.value</code>).

emailstring nullable

<i>E-mail</i> de contato do cliente.

motherNamestring nullable

Nome da mãe informado no registro do cliente.

birthDatestring date-time

Data de nascimento do cliente, no formato ISO 8601 - UTC.

registerNamestring

Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente.

socialNamestring nullable

Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais na documentação Cartilha do nome social.

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

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

profile'COMPLETE' | 'SIMPLE'

Perfil do cliente.

createdAtstring date-time

Data do primeiro registro do cliente.

updatedAtstring date-time nullable

Data da atualização do registro do cliente.

declaredIncome'LESS_THAN_ONE_THOUSAND' | 'FROM_ONE_THOUSAND_TO_TWO_THOUSAND' | 'FROM_TWO_THOUSAND_TO_THREE_THOUSAND' | 'FROM_THREE_THOUSAND_TO_FIVE_THOUSAND' | 'FROM_FIVE_THOUSAND_TO_TEN_THOUSAND' | 'FROM_TEN_THOUSAND_TO_TWENTY_THOUSAND' | 'OVER_TWENTY_THOUSAND'

Faixa de renda declarada pelo cliente. Campo <b>obsoleto</b> em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto <code>assertedIncome</code>.

confirmedIncomestring

Indica se o valor informado da renda foi confirmado no <i>Bureau</i> de informação. O valor padrão desse campo é null.

occupation'OCP0001' | 'OCP0002' | 'OCP0003' | 'OCP0004' | 'OCP0005' | 'OCP0006' | 'OCP0007' | 'OCP0008' | 'OCP0009' | 'OCP0010' | 'OCP0011' | 'OCP0012' | 'OCP0013' | 'OCP0014' | 'OCP0015' | 'OCP0016' | 'OCP0017' | 'OCP0018' | 'OCP0019' | 'OCP0020' | 'OCP0021' | 'OCP0022' | 'OCP0023' | 'OCP0024' | 'OCP0025' | 'OCP0026' | 'OCP0027' | 'OCP0028' | 'OCP0029' | 'OCP0030' | 'OCP0031' | 'OCP0032' | 'OCP0033' | 'OCP0034' | 'OCP0035' | 'OCP0036' | 'OCP0037' | 'OCP0038' | 'OCP0039' | 'OCP0040' | 'OCP0041' | 'OCP0042' | 'OCP0043' | 'OCP0044' | 'OCP0045' | 'OCP0046' | 'OCP0047' | 'OCP0048' | 'OCP0049' | 'OCP0050' | 'OCP0051' | 'OCP0052' | 'OCP0053' | 'OCP0054' | 'OCP0055' | 'OCP0056' | 'OCP0057' | 'OCP0058' | 'OCP0059' | 'OCP0060' | 'OCP0061' | 'OCP0062' | 'OCP0063' | 'OCP0064' | 'OCP0065' | 'OCP0066' | 'OCP0067' | 'OCP0068' | 'OCP0069' | 'OCP0070' | 'OCP0071' | 'OCP0072' | 'OCP0073' | 'OCP0074' | 'OCP0075' | 'OCP0076' | 'OCP0077' | 'OCP0078' | 'OCP0079' | 'OCP0080' | 'OCP0081' | 'OCP0082' | 'OCP0083' | 'OCP0084' | 'OCP0085' | 'OCP0086' | 'OCP0087' | 'OCP0088' | 'OCP0089' | 'OCP0090' | 'OCP0091' | 'OCP0092' | 'OCP0093' | 'OCP0094' | 'OCP0095' | 'OCP0096' | 'OCP0097' | 'OCP0098' | 'OCP0099' | 'OCP0100' | 'OCP0101' | 'OCP0102' | 'OCP0103' | 'OCP0104' | 'OCP0105'

Código de ocupação do cliente. Para conhecer a descrição dos códigos das ocupações, consulte a documentação Código de ocupação do cliente.

Changes

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