---
title: "Atualização cadastral"
method: PATCH
path: "/customers/{documentNumber}"
tags: ["Pessoa física"]
---

# Atualização cadastral

`PATCH /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

<div class="bkly-ref-description">
  <p>Realize a atualização de determinados dados cadastrais de clientes do tipo pessoa física.</p>
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">scope: customer.update</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Atualização cadastral](/docs/atualizacao-cadastral)."
}
[/block]

## Headers

- `x-correlation-id` string, required: Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

## 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)

## Request body

- UpdateCustomerRequest
  - `data` DataUpdateCustomerRequest
    - `email` string: Novo endereço de <i>e-mail</i>.
    - `socialName` string, nullable: Nome pelo qual a pessoa gostaria de ser chamada. Para saber mais, consulte a [Cartilha do nome social](https://www.mds.gov.br/webarquivos/publicacao/assistencia_social/Folders/cartilha_nome_social.pdf).
    - `phone` PhonePf
      - `countryCode` string, required: Código DDI do país. Atente-se à lista de países bloqueados para o Onboarding presente na página <a href="https://docs.bankly.com.br/docs/registro-pessoa-fisica">Registro de pessoa física</a>.
      - `number` string, required: Número de telefone incluindo DDD.
    - `address` Address
      - `zipCode` string, required: Código postal do endereço.
      - `addressLine` string, required: Logradouro (nome da rua, avenida etc.).
      - `buildingNumber` string, required: Número do imóvel.
      - `complement` string, nullable: Complemento do endereço. Exemplo: Apto 123, Casa B etc.
      - `neighborhood` string, required: Nome do bairro ou distrito.
      - `city` string, required: Nome da cidade.
      - `state` string, required: Sigla do estado brasileiro conforme a ISO 3166-2:BR.
      - `country` string, required: Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR.
    - `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>.
    - `assertedIncome` AssertedIncome: Objeto que deverá conter os dados da renda do cliente.
      - `value` number, required: Valor em Reais da renda declarada pelo cliente. O valor mínimo para esse campo é de: 0.00, e o valor máximo: 99999999999999.99 (até 14 caracteres antes do ponto e até dois caracteres após o ponto).
      - `currency` string: Moeda da renda declarada.
    - `pep` Pep: Objeto onde deve ser informado o nível de exposição política do cliente, atendendo à Circular nº 3.978.
      - `level` 'NONE' | 'SELF' | 'RELATED', required: Nível de exposição política do cliente.
    - `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). <br/><b>Importante:</b> deve-se enviar somente o código. Caso o cliente possua mais de uma ocupação, esse campo deve ser preenchido com a sua principal fonte de renda.

## Response `200`

Cadastro atualizado com sucesso.

- UpdateCustomerResponse
  - `data` DataUpdateCustomerResponse
    - `documentNumber` string: Número de documento de CPF. (<b>Obsoleto</b>. Considere o campo <code>document.value</code>).
    - `document` object: Objeto que contém informações sobre o documento do cliente.
      - `value` string: Número do documento.
      - `type` string: Tipo do documento (nesse caso, "CPF").
    - `profile` 'COMPLETE' | 'SIMPLE': Perfil do cliente.
    - `status` 'PENDING_APPROVAL' | 'APPROVED' | 'IN_ANALYSIS' | 'REPROVED' | 'REVOKED' | 'CANCELED' | 'BLACKLISTED': </i>Status</i> da análise KYC realizada no registro do cliente.
    - `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, informado no registro do cliente ou atualizado. Para saber mais, consulte a [Cartilha do nome social](https://www.mds.gov.br/webarquivos/publicacao/assistencia_social/Folders/cartilha_nome_social.pdf).
    - `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: E-mail de contato do cliente, informado em seu registro ou atualizado.
    - `motherName` string: Nome completo da mãe do cliente conforme consta no documento de identificação. <b>Sem abreviações</b>.
    - `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>.
    - `confirmedIncome` string: Indica se o valor informado da renda foi confirmado no Bureau de informação. O valor padrão desse campo é null.
    - `assertedIncome` AssertedIncomeResponse
      - `value` number: Valor em Reais da renda declarada pelo cliente.
      - `currency` string: Moeda da renda declarada.
    - `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). <br/><b>Importante:</b> deve-se enviar somente o código. Caso o cliente possua mais de uma ocupação, esse campo deve ser preenchido com a sua principal fonte de renda.
    - `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: <i>Token</i> retornado no <i>endpoint</i> de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one).
      - `idCardFront` string: <i>Token</i> retornado no <i>endpoint</i> de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one).
      - `idCardBack` string: <i>Token</i> retornado no <i>endpoint</i> de [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one).
    - `birthDate` string, date-time: Data de nascimento do cliente, no formato ISO 8601 - UTC.
    - `createdAt` string, date-time: Data do primeiro registro do cliente.
    - `updatedAt` string, date-time: Data da atualização do registro do cliente.
  - `links` object: Lista que contém objetos referentes ao HATEOS.

## Other responses

- `400` (unresolved $ref)
- `404` (unresolved $ref)
- `422` (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)