--- title: "Consulta do registro do cliente" method: GET path: "/customers/{documentNumber}" tags: ["Pessoa física"] --- # Consulta do registro do cliente `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

Obtenha um resultado resumido (BASIC) ou detalhado (DETAILED) dos dados de registro de um cliente.

stable scope: customer.read
[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] ## 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 `200` Recurso encontrado. - CustomerResponse - `documentNumber` string: Número do documento CPF do cliente. (Obsoleto. Considere o campo document.value). - `document` object: Objeto que contém informações sobre o documento do cliente. - `value` string: Número do documento. - `type` string: Tipo do documento, o qual pode ser "CPF" ou "CNPJ". - `phone` PhoneResponse - `countryCode` string: Código DDI do país. - `number` string: Número de telefone incluindo DDD. - `address` AddressResponse - `zipCode` string: O CEP correspondente ao endereço. - `addressLine` string: Logradouro (Nome da rua, avenida etc.). - `buildingNumber` string: Número da residência. - `complement` string, nullable: Complemento do endereço. Exemplo: Apto 123, Casa B etc. - `neighborhood` string: Nome do bairro ou distrito. - `city` string: Nome da cidade. - `state` string: Sigla do estado brasileiro conforme a ISO 3166-2:BR. - `country` string: Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR. - `email` string, nullable: E-mail de contato do cliente. - `motherName` string, nullable: Nome da mãe informado no registro do cliente. - `birthDate` string, date-time: Data de nascimento do cliente, no formato ISO 8601 - UTC. - `registerName` string: Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. - `socialName` string, nullable: Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais na documentação [Cartilha do nome social](https://www.mds.gov.br/webarquivos/publicacao/assistencia_social/Folders/cartilha_nome_social.pdf). - `status` 'PENDING_APPROVAL' | 'APPROVED' | 'IN_ANALYSIS' | 'REPROVED' | 'REVOKED' | 'CANCELED' | 'BLACKLISTED': Status da análise KYC realizada no registro do cliente. - `profile` 'COMPLETE' | 'SIMPLE': Perfil do cliente. - `createdAt` string, date-time: Data do primeiro registro do cliente. - `updatedAt` string, 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 obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome. - `assertedIncome` AssertedIncomeResponse - `value` number: Valor em Reais da renda declarada pelo cliente. - `currency` string: Moeda da renda declarada. - `confirmedIncome` string: Indica se o valor informado da renda foi confirmado no Bureau 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](https://docs.bankly.com.br/docs/codigo-de-ocupacao-cliente). - `pep` PepResponse: Objeto que informa o nível de exposição política do cliente, atendendo à Circular nº 3.978. - `level` 'NONE' | 'SELF' | 'RELATED': Nível de exposição política do cliente. - `verified` boolean: Indica se a situação de vínculo com pessoa politicamente exposta foi verificada no Bureau de informação. O valor default desse campo é false. - `documentation` SendedDocumentationResponse: Objeto que contém as informações referentes aos documentos enviados para análise. - `selfie` string: Token retornado no endpoint de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one). - `idCardFront` string: Token retornado no endpoint de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one). - `idCardBack` string: Token retornado no endpoint de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one). ## Other responses - `400` (unresolved $ref) - `403` (unresolved $ref) - `404` (unresolved $ref) - `500` (unresolved $ref) --- [API](https://skmtc.dev/bankly/apis/registro-do-cliente.md) - [All operations](https://skmtc.dev/bankly/apis/registro-do-cliente/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/registro-do-cliente/revisions/8062de128aa6?raw)