Contexto
Neste artigo, vamos apresentar como realizar a alteração de dados de uma conta por meio da nossa API. A alteração é permitida para diversos campos, com restrições específicas dependendo do tipo de conta (Pessoa Física ou Jurídica), conforme as diretrizes de integridade de dados cadastrais.
Pré-requisitos
Antes de realizar a alteração de dados da conta, certifique-se de que:
- Está autenticado com um token válido da nossa API;
- Possui client_id e client_secret ativos;
- Salvou previamente o accountId da conta a ser atualizada;
- Os campos imutáveis estão mantidos exatamente como foram enviados na criação da conta.
1. Atualizar Dados da Conta
▶️ Endpoint
POST {{url}}/v1/accounts/{{accountId}}
Exemplo de payload:
{
"externalIdentifier": "{{UUID}}",
"client": {
"name": "PESSOA JURIDICA",
"taxIdentifier": {
"taxId": "77331144000155",
"country": "BRA"
},
"mobilePhone": {
"country": "BRA",
"phoneNumber": "199{{seq_telefone}}"
},
"email": "email.alterado@mp.com.br"
},
"billingAddress": {
"logradouro": "Rua ALTERADA",
"numero": "25",
"complemento": "COMP ALTERADO",
"bairro": "ALTERADO",
"cidade": "CIDADE ALTERADA",
"estado": "MG",
"cep": "13010210",
"pais": "BRA"
},
"clientType": "CORPORATE",
"accountType": "UNLIMITED_ORDINARY",
"additionalDetailsCorporate": {
"establishmentDate": "1990-05-29",
"companyName": "Nome da Empresa",
"businessLine": 47,
"establishmentForm": 1,
"representatives": [
{
"name": "Representante ALTERADO da PJ",
"taxIdentifier": {
"taxId": "{{CPF_Original}}",
"country": "BRA"
},
"mobilePhone": {
"country": "BRA",
"phoneNumber": "129{{seq_telefone}}"
},
"email": "representante.alterado.pj@mp.com.br",
"mailAddress": {
"logradouro": "Rua Sacramento",
"numero": "15",
"complemento": "Casa",
"bairro": "Centro",
"cidade": "São Paulo",
"estado": "SP",
"cep": "13720000",
"pais": "BRA"
}
}
]
}
}
⚠️ Observações Importantes Campos como client.name, taxIdentifier.taxId e additionalDetailsCorporate.companyName devem manter os valores originais enviados na criação da conta. |
2. Regras de Alteração por Tipo de Conta
Tipo de Conta | Campos Imutáveis |
---|---|
Pessoa Física | client.name, taxIdentifier.taxId (Nome e CPF) |
Pessoa Jurídica | client.name, additionalDetailsCorporate.companyName, taxIdentifier.taxId |
⚠️ Observações Importantes
|
3. Códigos de Erro
Código de Erro | HTTP Code | Descrição (PT-BR) |
---|---|---|
AG-45 | 400 | Não é permitido alterar o campo client.name, additionalDetailsCorporate.companyName e taxIdentifier.taxId |
AG-46 | 400 | Não é permitido alterar o campo client.name e taxIdentifier.taxId |
Suporte
Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte