跳到主要内容

Atualizar Parte Relacionada


Introdução

Este recurso corrige os dados de uma parte relacionada já criada — percentual de participação, endereço, renda, tipo de vínculo ou qualquer outro campo enviado na criação.

É o caminho para resolver uma recusa de participação societária (IVR000166, IVR000169, IVR000170) sem precisar abrir uma nova análise cadastral: ajuste o percentual e reenvie o submit.

Corrigir ou desativar?
  • Para ajustar dados de uma parte que continua fazendo parte do cadastro, use este endpoint
  • Para remover uma parte do cadastro, use Atualizar Status da Parte Relacionada com status: "inactive". Não existe DELETE — partes relacionadas nunca são apagadas fisicamente

Input / Output:

Como input devem ser enviados os dados da parte relacionada. O corpo é uma substituição completa: envie todos os campos, não apenas os que mudaram.

Como output será retornada a representação atualizada da parte relacionada.

Request

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/related_party/{external_related_party_key}
MÉTODO
PUT
STATUS
200
Use o external_related_party_key

A chave aceita nesta URL é o external_related_party_key devolvido na criação da parte relacionada — não o related_party_key. Uma chave desconhecida é recusada com IVR000183.

Atenção: as mensagens de erro do submit (IVR000030) citam a parte relacionada pelo related_party_key interno, que não funciona nesta rota. Para correlacionar as duas chaves, consulte a análise cadastral — o objeto de cada parte relacionada traz ambas.

Request body

Request Body
{
"name": "João Silva",
"document_number": "123.456.789-00",
"person_type": "natural_person",
"related_party_type": "partner",
"resident": true,
"legal_representative": true,
"direct_beneficiary": true,
"participation_percentage": 0.85,
"monthly_income": 50000.00,
"address": {
"postal_code": "01000-000",
"street": "Rua das Flores",
"number": "123",
"neighborhood": "Centro",
"city": "São Paulo",
"uf": "SP",
"country": "BRA"
},
"email": "joao.silva@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "987654321"
}
}

Body params

Os campos são os mesmos de Criar Parte Relacionada, com uma diferença:

CampoDiferença em relação à criação
document_numberSempre obrigatório neste endpoint, inclusive para partes com resident: false

Todas as demais regras condicionais continuam valendo — address obrigatório para legal_person ou quando direct_beneficiary: true, monthly_income obrigatório para pessoa física com direct_beneficiary: true, e assim por diante.

A análise não pode estar em estado terminal

A atualização é recusada com IVR000185 quando a análise cadastral já está em um dos status finais: automatically_approved, automatically_reproved, manually_approved, manually_reproved, analysis_complete ou expired.

Se o cadastro já foi analisado, a correção passa por abrir uma nova análise via Atualização Cadastral.

Response

Response Body
{
"related_party_key": "UUID",
"external_related_party_key": "UUID",
"name": "João Silva",
"document_number": "123.456.789-00",
"person_type": "natural_person",
"related_party_type": "partner",
"status": "active",
"resident": true,
"legal_representative": true,
"direct_beneficiary": true,
"address": {},
"participation_percentage": 0.85,
"monthly_income": 50000.00,
"email": "joao.silva@example.com",
"phone": {}
}