Pular para o conteúdo principal

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_data
MÉTODO
PUT
STATUS
202

Request 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

CampoTipoDescriçãoCaracteresObrigatório
namestringNome do investidor1 - 255Sim
emailstringE-mail do investidor1 - 255Sim
phoneobjectObjeto de Phone-Sim
natural_personobjectObjeto de Natural Person (obrigatório para pessoa física)-Sim*
legal_personobjectObjeto 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

CampoTipoDescriçãoCaracteresObrigatório
birthdatestringData de nascimento (formato: YYYY-MM-DD)10Sim
genderstringGênero. Enumerador de Gender1 - 6Não
mother_namestringNome completo da mãe1 - 255Sim
nationalitystringNacionalidade1 - 255Sim
place_of_birthobjectObjeto de Place of Birth-Sim
marital_statusstringEstado civil1 - 255Sim
spouseobjectObjeto de Spouse-Não
professionstringProfissão1 - 255Sim
occupationstringOcupação1 - 255Sim
occupation_companyobjectObjeto de Occupation Company-Não

Gender

EnumeradorDescrição
maleMasculino
femaleFeminino

Place of Birth

CampoTipoDescriçãoCaracteresObrigatório
countrystringPaís-Não
ufstringEstado (UF)-Não
citystringCidade-Não

Spouse

CampoTipoDescriçãoCaracteresObrigatório
namestringNome completo do cônjuge1 - 255Sim
document_numberstringCPF ou CNPJ do cônjuge (formato: XXX.XXX.XXX-XX ou XX.XXX.XXX/XXXX-XX)14Sim

Occupation Company

CampoTipoDescriçãoCaracteresObrigatório
namestringNome da empresa1 - 255Sim
document_numberstringCNPJ da empresa (formato: XX.XXX.XXX/XXXX-XX)18Sim
CampoTipoDescriçãoCaracteresObrigatório
legal_namestringRazão social da empresa1 - 255Sim
constitution_datestringData de constituição da empresa (formato: YYYY-MM-DD)10Sim

Phone

CampoTipoDescriçãoCaracteresObrigatório
international_dial_codestringCódigo internacional1 - 3Sim
area_codestringCódigo de área2Sim
numberstringNúmero de telefone8 - 9Sim

Response

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