Enviar dados Cadastrais do Investidor
Introdução
Este recurso tem como objetivo nos informar os dados cadastrais referentes ao tipo de pessoa que vão compor a análise cadastral de um investidor.
Input / Output:
Como input deve ser enviado os dados cadastrais específicos conforme o tipo de investidor (natural_person ou legal_person).
Como output será entregue uma investor_key e uma investor_analysis_key.
Request
ENDPOINT
/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/registry_dataMÉTODO
PUTSTATUS
202Request body
Exemplo: Enviar Dados Cadastrais Pessoa Física
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"
}
}
}
Exemplo: Enviar Dados Cadastrais Pessoa Jurídica
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
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
name | string | Nome do investidor | 1 - 255 | Sim |
email | string | E-mail do investidor | 1 - 255 | Sim |
phone | object | Objeto de Phone | - | Sim |
natural_person | object | Objeto de Natural Person (obrigatório para pessoa física) | - | Sim* |
legal_person | object | Objeto de Legal Person (obrigatório para pessoa jurídica) | - | Sim* |
* natural_person é obrigatório quando person_type é natural_person. legal_person é obrigatório quando person_type é legal_person.
Natural Person
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
birthdate | string | Data de nascimento (formato: YYYY-MM-DD) | 10 | Sim |
gender | string | Gênero. Enumerador de Gender | 1 - 6 | Não |
mother_name | string | Nome completo da mãe | 1 - 255 | Sim |
nationality | string | Nacionalidade | 1 - 255 | Sim |
place_of_birth | object | Objeto de Place of Birth | - | Sim |
marital_status | string | Estado civil | 1 - 255 | Sim |
spouse | object | Objeto de Spouse | - | Não |
profession | string | Profissão | 1 - 255 | Sim |
occupation | string | Ocupação | 1 - 255 | Sim |
occupation_company | object | Objeto de Occupation Company | - | Não |
Gender
| Enumerador | Descrição |
|---|---|
male | Masculino |
female | Feminino |
Place of Birth
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
country | string | País | - | Não |
uf | string | Estado (UF) | - | Não |
city | string | Cidade | - | Não |
Spouse
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
name | string | Nome completo do cônjuge | 1 - 255 | Sim |
document_number | string | CPF ou CNPJ do cônjuge (formato: XXX.XXX.XXX-XX ou XX.XXX.XXX/XXXX-XX) | 14 | Sim |
Occupation Company
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
name | string | Nome da empresa | 1 - 255 | Sim |
document_number | string | CNPJ da empresa (formato: XX.XXX.XXX/XXXX-XX) | 18 | Sim |
Legal Person
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
legal_name | string | Razão social da empresa | 1 - 255 | Sim |
constitution_date | string | Data de constituição da empresa (formato: YYYY-MM-DD) | 10 | Sim |
Phone
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
international_dial_code | string | Código internacional | 1 - 3 | Sim |
area_code | string | Código de área | 2 | Sim |
number | string | Número de telefone | 8 - 9 | Sim |
Response
Response Body
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}