Pular para o conteúdo principal

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).

Regra de aprovação em sandbox

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).

Disponível em
PerfilHost
Investidorinvestor-api

URL base de cada host: Ambientes (Hosts).

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": "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
Request Body
{
"name": "Empresa XPTO Ltda",
"document_number": "22.333.444/0001-81",
"person_type": "legal_person",
"investor_sub_type": "default",
"investor_owner_type": "wallet_manager"
}
Campos obrigatórios

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_type e, quando investor_owner_type não é enviado, email e phone
  • legal_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​

CampoTipoDescriçãoCaracteresObrigatório
namestringNome (ou razão social) do investidor1 - 255Sim
person_typestringEnumerador de Person Type-Sim
document_numberstringCPF (XXX.XXX.XXX-XX) ou CNPJ (XX.XXX.XXX/XXXX-XX)14 ou 18Sim*
investor_sub_typestringEnumerador de Investor Sub Type-Não
emailstringE-mail do investidor. Obrigatório para natural_person sem investor_owner_type1 - 255Condicional
phoneobjectObjeto de Phone. Obrigatório para natural_person sem investor_owner_type-Condicional
investor_owner_typestringTipo de relação com o investidor criado - Enumerador de Investor Owner Type1 - 255Sim

Phone​

CampoTipoDescriçãoCaracteresObrigatório
international_dial_codestringCódigo internacional (ex.: 55)1 - 3Sim
area_codestringDDD2Sim
numberstringNúmero do telefone8 - 9Sim

Person Type​

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

Investor Sub Type​

EnumeradorDescrição
defaultPessoa jurídica regular (default quando o campo não é informado)

Investor Owner Type​

EnumeradorDescrição
wallet_managerGestor de Carteira

Response​

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

Erros​

StatusCódigoQuando acontece
400IVR000004CPF/CNPJ com dígito verificador inválido, ou CPF enviado com legal_person (e vice-versa)
400IVR000009Falta um campo obrigatório do person_type
400IVR000153investor_owner_type não enviado
400IVR000255investor_sub_type: non_resident. Use resident: false e non_resident_type
400IVR000258 / IVR000259Subtipo default declarado para um CNPJ que é instituição financeira registrada ou classe na CVM
409IVR000007Você já cadastrou um investidor com este documento

Erros de autenticação, permissão e host: veja Erros da API.