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).
Em sandbox, o resultado da análise depende do primeiro dígito do CPF/CNPJ: início 1 → reprovação automática; início 8 → análise manual; os demais são aprovados automaticamente.
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).
| Perfil | Host |
|---|---|
| Investidor | investor-api |
URL base de cada host: Ambientes (Hosts).
Request
/investor_registry/investorPOST201Request body
Caso 01: Pessoa Física
{
"name": "João da Silva",
"document_number": "969.698.790-03",
"person_type": "natural_person",
"email": "joao.silva@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "987654321"
},
"investor_owner_type": "wallet_manager"
}
Caso 02: Pessoa Jurídica
{
"name": "Empresa XPTO Ltda",
"document_number": "22.333.444/0001-81",
"person_type": "legal_person",
"investor_sub_type": "default",
"investor_owner_type": "wallet_manager"
}
Os campos obrigatórios mudam de acordo com o person_type. A ausência de qualquer um deles é recusada com IVR000009.
natural_person:name,document_number,person_typee, quandoinvestor_owner_typenão é enviado,emailephonelegal_person:name,document_number,person_type
investor_owner_type é obrigatório para a gestora de carteira: sem ele, a chamada é recusada com IVR000153. Com ele, email e phone são dispensados em natural_person.
investor_sub_type é opcional; non_resident é recusado com IVR000255.
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. Obrigatório para natural_person sem investor_owner_type | 1 - 255 | Condicional |
phone | object | Objeto de Phone. Obrigatório para natural_person sem investor_owner_type | - | Condicional |
investor_owner_type | string | Tipo de relação com o investidor criado - Enumerador de Investor Owner Type | 1 - 255 | Sim |
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 |
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) |
Investor Owner Type
| Enumerador | Descrição |
|---|---|
wallet_manager | Gestor de Carteira |
Response
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 400 | IVR000004 | CPF/CNPJ com dígito verificador inválido, ou CPF enviado com legal_person (e vice-versa) |
| 400 | IVR000009 | Falta um campo obrigatório do person_type |
| 400 | IVR000153 | investor_owner_type não enviado |
| 400 | IVR000255 | investor_sub_type: non_resident. Use resident: false e non_resident_type |
| 400 | IVR000258 / IVR000259 | Subtipo default declarado para um CNPJ que é instituição financeira registrada ou classe na CVM |
| 409 | IVR000007 | Você já cadastrou um investidor com este documento |
Erros de autenticação, permissão e host: veja Erros da API.