Criar investidor / análise do investidor

---

Introdução

Este recurso tem como objetivo nos informar dados básicos para iniciar a análise cadastral de um investidor. Existem 2 tipos de análise cadastral: pessoa física e pessoa jurídica.

Input / Output:

Cada um dos tipos de análise cadastral espera um conjunto de dados como input, segue abaixo exemplos de como iniciar cada uma dessas esteiras.

Como output será entregue uma investor_key e uma investor_analysis_key. A investor_analysis_key é utilizada para identificar a análise cadastral criada. A investor_key é utilizada para identificar o investidor ao qual a análise cadastral pertence.

Assim, uma única investor_key (investidor) pode estar associada a uma ou mais investor_analysis_key (análise cadastral).

Tanto a investor_key quanto a investor_analysis_key serão utilizadas em outros endpoints que interagem com o investidor ou com a análise cadastral.

Request

ENDPOINT

/investor_registry/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

Campo	Tipo	Descrição	Caracteres	Obrigatório
name	string	Nome do investidor	1 - 255	Sim
document_number	string	CPF ou CNPJ	13 - 18	Sim
person_type	string	Enumerador de Person Type	-	Sim
email	string	E-mail	1 - 255	Não
phone	JSON	Objeto de Phone	-	Não
registry_user	JSON	Objeto de Registry User	-	Não

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

Registry User

Campo	Tipo	Descrição	Caracteres	Obrigatório
name	string	Nome do usuário cadastrador	1 - 255	Sim
document_number	string	CPF ou CNPJ	13 - 18	Sim
person_type	string	Enumerador de Person Type	-	Sim
email	string	E-mail	1 - 255	Sim
phone	JSON	Objeto de Phone	-	Sim

Person Type

Enumerador	Descrição
natural_person	Pessoa física
legal_person	Pessoa jurídica

Response

Response Body

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