Parceiros que precisam atualizar ou recadastrar seus clientes podem realizar a atualização via API, desde que tenham um usuário devidamente configurado. Os dados passarão por um processo de auditoria e validação automática. Alguns dados podem exigir validação manual, necessitando o anexo de documentos.
O fluxo se resume no seguinte conjunto de etapas:
- Detalhamento dos dados cadastrais:
- Etapa opcional que fornece os dados atuais do cadastro do cliente. É útil para verificar previamente as informações atuais do cadastro.
-
- Recadastramento de clientes:
- Concretiza a ação de atualização. Uma vez chamada, as mudanças serão refletidas no perfil do cliente e registradas no histórico.
- Sem mudanças cadastrais:
- Informa que o cliente está com os dados atualizados e nenhuma mudança será feita.
- Somente documentos de identificação válidos serão aceitos.
- Não será possível alterar os dados cadastrais de clientes que se enquadrem nos termos da Lei FATCA.
- As siglas dos estados e códigos de municípios devem seguir os disponibilizados no site do IBGE. Se necessário, a documentação da API da instituição está disponível aqui.
- O campo de código de segurança será exigido caso o tipo de documento seja CNH, atualmente com ID 2.
- Caso o valor de ativos declarado seja acima de R$ 1.000.000,00, é obrigatório informar o valor das aplicações financeiras no campo
net_asset_value.
Se for necessário informar que o cliente não teve alterações cadastrais e se encontra no status de recadastramento, pode-se utilizar uma rota específica para confirmar que não há mudanças cadastrais.
Enumeradores do fluxo.
| Valor | Descrição |
|---|
| 1 | Brasileiro Nato |
| 2 | Brasileiro Naturalizado |
| 3 | Estrangeiro |
| Valor | Descrição |
|---|
| M | Masculino |
| F | Feminino |
| Valor | Descrição |
|---|
| 1 | Solteiro(a) |
| 2 | Casado(a) |
| 3 | Separado(a) |
| 4 | Divorciado(a) |
| 5 | Viúvo(a) |
| 6 | União estável |
| Valor | Descrição |
|---|
| 0 | Nenhum |
| 1 | Até R$50.000,00 |
| 2 | De R$50.000,01 a R$100.000,00 |
| 3 | De R$100.000,01 a R$200.000,00 |
| 4 | De R$200.000,01 a R$300.000,00 |
| 5 | De R$300.000,01 a R$1.000.000,00 |
| 6 | Acima de R$1.000.000,00 |
| Valor | Descrição |
|---|
| 0 | Nenhum |
| 1 | Até R$5.000,00 |
| 2 | De R$5.000,01 a R$10.000,00 |
| 3 | De R$10.000,01 a R$20.000,00 |
| 4 | De R$20.000,01 a R$30.000,00 |
| 5 | De R$30.000,01 a R$100.000,00 |
| 6 | Acima de R$100.000,00 |
| Valor | Descrição |
|---|
| 20 | Iniciando nova alteração |
| 21 | Verificação de aprovação automática |
| 22 | Cancelado |
| 23 | Expirado |
| 6 | Cadastro alterado (alteração finalizada = aguardando documentação) |
| 7 | Upload documento iniciado |
| 8 | Upload documento finalizado (upload finalizado = em análise) |
| 9 | Pendente |
| 10 | Correção iniciada |
| 11 | Correção finalizada |
| 12 | Aguardando aprovação |
| 13 | Aprovado |
