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_dataMETHOD
PUTSTATUS
202Request 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
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
name | string | Investor name | 1 - 255 | Yes |
email | string | Investor email | 1 - 255 | Yes |
phone | object | Phone object | - | Yes |
natural_person | object | Natural Person object (required for natural person) | - | Yes* |
legal_person | object | Legal 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
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
birthdate | string | Birth date (format: YYYY-MM-DD) | 10 | Yes |
gender | string | Gender. Gender enumerator | 1 - 6 | No |
mother_name | string | Mother's full name | 1 - 255 | Yes |
nationality | string | Nationality | 1 - 255 | Yes |
place_of_birth | object | Place of Birth object | - | Yes |
marital_status | string | Marital status | 1 - 255 | Yes |
spouse | object | Spouse object | - | No |
profession | string | Profession | 1 - 255 | Yes |
occupation | string | Occupation | 1 - 255 | Yes |
occupation_company | object | Occupation Company object | - | No |
Gender
| Enumerator | Description |
|---|---|
male | Male |
female | Female |
Place of Birth
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
country | string | Country | - | No |
uf | string | State (UF) | - | No |
city | string | City | - | No |
Spouse
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
name | string | Spouse's full name | 1 - 255 | Yes |
document_number | string | Spouse's CPF or CNPJ (format: XXX.XXX.XXX-XX or XX.XXX.XXX/XXXX-XX) | 14 | Yes |
Occupation Company
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
name | string | Company name | 1 - 255 | Yes |
document_number | string | Company CNPJ (format: XX.XXX.XXX/XXXX-XX) | 18 | Yes |
Legal Person
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
legal_name | string | Company legal name | 1 - 255 | Yes |
constitution_date | string | Company constitution date (format: YYYY-MM-DD) | 10 | Yes |
Phone
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
international_dial_code | string | International dial code | 1 - 3 | Yes |
area_code | string | Area code | 2 | Yes |
number | string | Phone number | 8 - 9 | Yes |
Response
Response Body
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}