Criar investidor

---

Introdução

Este recurso tem como objetivo nos informar dados básicos para iniciar o cadastro de um investidor.

A criação de um investidor já dispara, em conjunto, a abertura de uma primeira análise cadastral vinculada a ele. Por isso, ao final desta chamada são retornadas duas chaves: investor_key (identifica o investidor) e investor_analysis_key (identifica a análise cadastral em andamento).

Existem 2 tipos principais de investidor, definidos pelo campo person_type: pessoa física (natural_person) e pessoa jurídica (legal_person).

Informação

No ambiente de Homologação, temos a seguinte regra para aprovações: CPF/CNPJ com início 1: reprovação automática; CPF/CNPJ com início 8: pendente de validação manual; o restante é aprovado automaticamente.

Informação

Para a integração de gestores ou consultores é possível determinar se o investidor irá preencher os dados através da plataforma, ou não. Caso o investidor vá preencher o próprio cadastro, basta passar o query param create_investor_user = true

Input / Output

Como input envie os dados básicos do investidor. Os campos obrigatórios variam de acordo com person_type e investor_sub_type.

Como output serão retornadas a investor_key e a investor_analysis_key. A investor_key identifica o investidor; a investor_analysis_key identifica a análise cadastral aberta junto com a criação. Um mesmo investidor pode possuir mais de uma análise cadastral ao longo do tempo (renovações, atualizações).

Request

ENDPOINT

/investor_registry/investor

MÉTODO

POST

STATUS

201

Request body

Caso 01: Pessoa Física

Request Body

{
    "name": "João da Silva",
    "document_number": "123.456.789-00",
    "person_type": "natural_person",
    "email": "joao.silva@example.com",
    "phone": {
        "international_dial_code": "55",
        "area_code": "11",
        "number": "987654321"
    }
}

Caso 02: Pessoa Jurídica

Request Body

{
    "name": "Empresa XPTO Ltda",
    "document_number": "12.345.678/0001-90",
    "person_type": "legal_person",
    "investor_sub_type": "default",
    "registry_user": {
        "name": "José da Silva",
        "document_number": "123.456.789-00",
        "email": "jose.silva@example.com",
        "phone": {
            "international_dial_code": "55",
            "area_code": "11",
            "number": "987654321"
        }
    }
}

Atenção

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

• natural_person: name, document_number, person_type (email e phone recomendados para criação de usuário)
• legal_person: name, document_number, person_type, investor_sub_type e registry_user

Sobre o registry_user

O registry_user representa o usuário (pessoa física) responsável por preencher os dados cadastrais do investidor. Para pessoa física, normalmente este usuário é o próprio investidor e o campo pode ser omitido. Para pessoa jurídica, é o representante que responderá pelo preenchimento.

Body params

Campo	Tipo	Descrição	Caracteres	Obrigatório
name	string	Nome (ou razão social) do investidor	1 - 255	Sim
person_type	string	Enumerador de Person Type	-	Sim
document_number	string	CPF (XXX.XXX.XXX-XX) ou CNPJ (XX.XXX.XXX/XXXX-XX)	14 ou 18	Sim*
investor_sub_type	string	Enumerador de Investor Sub Type	-	Não
email	string	E-mail do investidor	1 - 255	Não
phone	object	Objeto de Phone	-	Não
registry_user	object	Objeto de Registry User	-	Não

Phone

Campo	Tipo	Descrição	Caracteres	Obrigatório
international_dial_code	string	Código internacional (ex.: 55)	1 - 3	Sim
area_code	string	DDD	2	Sim
number	string	Número do 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 do usuário (formato XXX.XXX.XXX-XX)	14	Sim
email	string	E-mail do usuário	1 - 255	Sim
phone	object	Objeto de Phone	-	Sim

Person Type

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

Investor Sub Type

Enumerador	Descrição
default	Pessoa jurídica regular (default quando o campo não é informado)

Response

Response Body

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