Skip to main content

Criar Investidor


Request

ENDPOINT
/investor_registry/distributor/DISTRIBUTOR_KEY/investor
MÉTODO
POST
STATUS
201

Request body

Request Body
{
"name": "string",
"document_number": "123.456.789-00",
"person_type": "natural_person | legal_person",
"email": "example@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
},
"registry_user": {
"name": "string",
"document_number": "123.456.789-00",
"email": "example@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
},
}
}
Atenção

Os campos obrigatórios mudam de acordo com o person_type.

  • Caso seja natural_person (pessoa física):

    • Os campos name, document_number, person_type, email e phone são obrigatórios
  • Caso seja legal_person (pessoa jurídica):

    • Os campos name, document_number, person_type, registry_user são obrigatórios
Informação

O registry_user é a entidade que representa o usuário que realizará o preenchimento dos dados cadastrais do investidor pessoa jurídica. No caso de pessoa física o próprio investidor preenche os seus dados cadastrais.

Caso 01: Cadastrar Pessoa Física
Request Body
{
"name": "João da Silva",
"document_number": "123.456.789-00",
"person_type": "natural_person",
"email": "example@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
}
}
Caso 02: Cadastrar Pessoa Jurídica
Request Body
{
"name": "Empresa XPTO",
"document_number": "12.456.789/0001-00",
"person_type": "legal_person",
"registry_user": {
"name": "José da Silva",
"document_number": "123.456.789-00",
"email": "example@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "1234567890"
},
}
}

Body params

CampoTipoDescriçãoCaracteresObrigatório
namestringNome do investidor1 - 255Sim
document_numberstringCPF ou CNPJ13 - 18Sim
person_typestringEnumerador de Person Type-Sim
emailstringE-mail1 - 255Não
phoneJSONObjeto de Phone-Não
registry_userJSONObjeto de Registry User-Não

Phone

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

Registry User

CampoTipoDescriçãoCaracteresObrigatório
namestringNome do usuário cadastrador1 - 255Sim
document_numberstringCPF ou CNPJ13 - 18Sim
person_typestringEnumerador de Person Type-Sim
emailstringE-mail1 - 255Sim
phoneJSONObjeto de Phone-Sim

Person Type

EnumeradorDescrição
natural_personPessoa física
legal_personPessoa jurídica

Response

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