Skip to main content

Send Investor Registry Data


Introduction

This resource aims to inform us of the registry data related to the type of person that will compose the registry analysis of an investor.

Input / Output:

As input, specific registry data should be sent according to the investor type (natural_person or legal_person).

As output, an investor_key and an investor_analysis_key will be delivered.

Request

ENDPOINT
/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/registry_data
METHOD
PUT
STATUS
202

Request body

Example: Send Natural Person Registry Data
Request Body
{
"name": "João da Silva",
"email": "joao.silva@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
},
"natural_person": {
"birthdate": "1990-05-15",
"gender": "male",
"mother_name": "Maria da Silva",
"nationality": "BRA",
"place_of_birth": {
"country": "BRA",
"uf": "SP",
"city": "São Paulo"
},
"marital_status": "single",
"spouse": {
"name": "Maria Santos",
"document_number": "123.456.789-00"
},
"profession": "Engenheiro",
"occupation": "Engenheiro de Software",
"occupation_company": {
"name": "Empresa XYZ Ltda",
"document_number": "12.345.678/0001-90"
}
}
}
Example: Send Legal Person Registry Data
Request Body
{
"name": "Empresa XPTO Ltda",
"email": "contato@empresaxpto.com.br",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
},
"legal_person": {
"legal_name": "Empresa XPTO Limitada",
"constitution_date": "2020-01-15"
}
}

Body params

FieldTypeDescriptionCharactersRequired
namestringInvestor name1 - 255Yes
emailstringInvestor email1 - 255Yes
phoneobjectPhone object-Yes
natural_personobjectNatural Person object (required for natural person)-Yes*
legal_personobjectLegal Person object (required for legal person)-Yes*

* natural_person is required when person_type is natural_person. legal_person is required when person_type is legal_person.

Natural Person

FieldTypeDescriptionCharactersRequired
birthdatestringBirth date (format: YYYY-MM-DD)10Yes
genderstringGender. Gender enumerator1 - 6No
mother_namestringMother's full name1 - 255Yes
nationalitystringNationality1 - 255Yes
place_of_birthobjectPlace of Birth object-Yes
marital_statusstringMarital status1 - 255Yes
spouseobjectSpouse object-No
professionstringProfession1 - 255Yes
occupationstringOccupation1 - 255Yes
occupation_companyobjectOccupation Company object-No

Gender

EnumeratorDescription
maleMale
femaleFemale

Place of Birth

FieldTypeDescriptionCharactersRequired
countrystringCountry-No
ufstringState (UF)-No
citystringCity-No

Spouse

FieldTypeDescriptionCharactersRequired
namestringSpouse's full name1 - 255Yes
document_numberstringSpouse's CPF or CNPJ (format: XXX.XXX.XXX-XX or XX.XXX.XXX/XXXX-XX)14Yes

Occupation Company

FieldTypeDescriptionCharactersRequired
namestringCompany name1 - 255Yes
document_numberstringCompany CNPJ (format: XX.XXX.XXX/XXXX-XX)18Yes
FieldTypeDescriptionCharactersRequired
legal_namestringCompany legal name1 - 255Yes
constitution_datestringCompany constitution date (format: YYYY-MM-DD)10Yes

Phone

FieldTypeDescriptionCharactersRequired
international_dial_codestringInternational dial code1 - 3Yes
area_codestringArea code2Yes
numberstringPhone number8 - 9Yes

Response

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