Skip to main content

Update Related Party


Introduction

This resource corrects the data of a related party that has already been created — ownership percentage, address, income, relationship type or any other field submitted at creation.

It is the way to resolve an ownership percentage rejection (IVR000166, IVR000169, IVR000170) without having to open a new registration analysis: adjust the percentage and resubmit the submit.

Correct or deactivate?
  • To adjust the data of a party that remains part of the registration, use this endpoint
  • To remove a party from the registration, use Update Related Party Status with status: "inactive". There is no DELETE — related parties are never physically deleted

Input / Output:

As input, the related party's data must be sent. The body is a complete replacement: send every field, not only the ones that changed.

As output, the updated representation of the related party is returned.

Request

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/related_party/{external_related_party_key}
METHOD
PUT
STATUS
200
Use the external_related_party_key

The key accepted in this URL is the external_related_party_key returned when the related party was created — not the related_party_key. An unknown key is rejected with IVR000183.

Note: the submit error messages (IVR000030) refer to the related party by the internal related_party_key, which does not work on this route. To correlate the two keys, query the registration analysis — each related party's object carries both.

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

The fields are the same as in Create Related Party, with one difference:

FieldDifference from creation
document_numberAlways required on this endpoint, including for parties with resident: false

All the other conditional rules still apply — address required for legal_person or when direct_beneficiary: true, monthly_income required for a natural person with direct_beneficiary: true, and so on.

The analysis cannot be in a terminal state

The update is rejected with IVR000185 when the registration analysis is already in one of the final statuses: automatically_approved, automatically_reproved, manually_approved, manually_reproved, analysis_complete or expired.

If the registration has already been analyzed, the correction requires opening a new analysis via Registration Update.

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": {}
}