Skip to main content

Send Investor Registry Data


Introduction

This feature aims to inform us of the registry data that will compose the registry analysis of an investor.

Input / Output:

The registry data changes according to the data passed in the Create investor step. Below are examples of what data should be sent for each variation.

As output, an investor_key and an investor_analysis_key will be delivered. The investor_analysis_key is used to identify the updated registry analysis. The investor_key is used to identify the investor to which the registry analysis belongs.

Request

ENDPOINT
/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/net_worth
METHOD
PUT
STATUS
202
Example
Request Body
{
"investor_category": "retail",
"total_net_worth": 0,
"total_financial_applications": 0,
"monthly_income": 0,
"other_incomes": 0,
"real_estate": 0,
"movable_assets": 0,
"resource_origin": "Possuo herança familiar"
}

Body params

FieldTypeDescriptionCharactersRequired
total_net_worthfloatTotal net worth-Yes
total_financial_applicationsfloatTotal in financial applications-Yes
monthly_incomefloatMonthly salary or revenue of the investor-Yes
real_estatefloatTotal net worth in real estate-Yes
movable_assetsfloatTotal net worth in movable assets-Yes
other_incomesfloatOther monthly incomes-Yes
resource_originstringOrigin of resources (if necessary)-Yes
investor_categoryenumeratorSelf-declared qualification of the investor-Yes

Investor Category

EnumeratorDescription
retailRetail
qualifiedQualified
professionalProfessional

Response

Response Body
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}