Send Related Party Document

---

Introduction

This resource is used to upload the required documents of each created related party.

Attention

• This endpoint must be called for each created related party that is a natural person
• The related party must have the active status to receive documents
• For a natural person: an identification document is required — cnh or the rg_front + rg_back pair
• For a legal entity (parent_company): no document is required
• The same type only accepts one successful upload: see Retry and duplicate document

Input / Output:

As input, the document in base64, the document type and the file extension must be sent.

As output, a related_party_document_key that identifies the uploaded document is delivered.

Available on

Profile	Host	Required permission
Manager	manager-api	Write
Consultant	consultant-api	Granted by the integration team

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/related_party/{external_related_party_key}/document

METHOD

POST

STATUS

201

Request body

Example: Identification Document (CNH)

Request Body

{
    "type": "cnh",
    "document_b64": "base64_encoded_document_content",
    "file_extension": "pdf"
}

Example: RG (Front and Back)

Request Body - Front

{
    "type": "rg_front",
    "document_b64": "base64_encoded_document_content",
    "file_extension": "pdf"
}

Request Body - Back

{
    "type": "rg_back",
    "document_b64": "base64_encoded_document_content",
    "file_extension": "pdf"
}

Example: Power of Attorney (for the attorney type)

Request Body

{
    "type": "power_of_attorney",
    "document_b64": "base64_encoded_document_content",
    "file_extension": "pdf"
}

Body params

Field	Type	Description	Characters	Required
type	string	Document type	1 - 50	Yes
document_b64	string	Base64 of the document	-	Yes
file_extension	string	File extension (pdf, png, jpeg)	1 - 10	Yes

Document Type (Related Party)

Enumerator	Description	Supported Extensions	Use
cnh	CNH (driver's license)	pdf, jpeg	Identification (option 1)
rg_front	Front of the RG	pdf, jpeg	Identification (option 2, with rg_back)
rg_back	Back of the RG	pdf, jpeg	Identification (option 2, with rg_front)
passport	Passport	pdf, jpeg	Identification of a foreign party
foreign_id	Foreign identity document	pdf, jpeg	Identification of a foreign party
power_of_attorney	Power of attorney	pdf, jpeg	Complementary, for attorney

Required Documents

The requirement is evaluated when the registration is sent for analysis (submit) and rejected with IVR000030. It is enough to satisfy one of the options.

Resident natural person related party

Option	Documents
1	cnh
2	rg_front + rg_back

Non-resident natural person related party

Option	Documents
1	passport
2	foreign_id

Legal entity related party (parent_company)

No document is required.

Power of attorney

For a related party of the attorney type, power_of_attorney is required and complementary: it is required in addition to the identification, and does not replace it. The party still needs cnh or the rg_front + rg_back pair. A missing power of attorney is rejected with IVR000148.

Retry and duplicate document

A type is considered satisfied as soon as there is, for that related party, a document of that type with the valid or in_manual_analysis status. New uploads of the same type are then rejected:

HTTP 409
{
  "title": "Already exists valid document for related party.",
  "code": "IVR000141"
}

While all documents of a type are invalid, new uploads are still accepted.

Response

Response Body

{
    "related_party_document_key": "UUID",
    "status": "in_manual_analysis"
}

Automatic validation

The document is automatically validated after the upload. The status can be:

• valid: automatically validated
• invalid: rejected in the automatic validation
• in_manual_analysis: referred to human review

For rejected documents, you can force the upload using the force=true parameter. When using this flag the document will necessarily be submitted for manual review — and it starts to satisfy the type requirement.

Errors

Status	Code	When it happens
400	IVR000024	The file is not valid base64
400	IVR000026	The analysis is no longer in pending_registry_data
400	IVR000145	The related party is not active
404	IVR000183	Related party not found
404	IVR000144	Unknown document type
409	IVR000141	There is already a valid (or under analysis) document of the same type
400	QIT000011	Through the manager (manager-api): the investor is not a fund class linked to it

Authentication, permission and host errors: see API Errors.