Pular para o conteúdo principal

Atualizar Status da Parte Relacionada


Introdução​

Este recurso ativa ou desativa uma parte relacionada dentro de uma análise cadastral.

Para uma parte enviada por engano, ou que deixou de compor o quadro societário, é desativada por aqui. Partes com status inactive são ignoradas em todas as validações do envio para análise — não contam para a exigência de quantidade mínima, não contam para o requisito de representante legal, não somam participação societária e não têm documentos cobrados.

Casos de uso
  • Sócio enviado por engano → desative com inactive
  • Quadro societário mudou → desative quem saiu e crie quem entrou
  • Participação somada acima de 100% (IVR000169) → desative a parte duplicada

Input / Output:​

Como input deve ser enviado o novo status.

Como output será retornada a confirmação da alteração.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiEscrita
Consultoriaconsultant-apiLiberada pelo time de integração

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/related_party/{external_related_party_key}/status
MÉTODO
PUT
STATUS
202

Request body​

Request Body
{
"status": "inactive"
}

Body params​

CampoTipoDescriçãoObrigatório
statusstringEnumerador de Related Party StatusSim

Related Party Status​

EnumeradorDescrição
activeParte considerada em todas as validações do envio para análise
inactiveParte desconsiderada em todas as validações. É o equivalente a remover a parte do cadastro
A análise não pode estar em estado terminal

A alteraçã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, expired ou canceled.

Inativar a parte inativa os grupos de assinantes dela

Ao passar uma parte relacionada para inactive, todo grupo de assinantes ativo que tenha o documento dela entre os signatários também é inativado e deixa de ser o padrão. Cadastre um novo grupo antes do submit, senão a recusa é IVR000180.

Uma external_related_party_key desconhecida na análise informada é recusada com IVR000183.

Erros​

StatusCódigoQuando acontece
400IVR000185A análise já foi encerrada (aprovada, recusada, concluída, expirada ou cancelada)
404IVR000183Parte relacionada não encontrada para o external_related_party_key
400IVR000075Valor de status inválido
400QIT000011Pela gestora (manager-api): o investidor não é uma classe de fundo vinculada a ela

Erros de autenticação, permissão e host: veja Erros da API.