Pular para o conteúdo principal

Cadastro Básico do Investidor

Este endpoint permite cadastrar as informações básicas de um investidor. O mesmo endpoint é utilizado tanto para investidores pessoa jurídica (PJ) quanto pessoa física (PF) — o corpo da requisição varia de acordo com o campo person_type.

Request

ENDPOINT
/investor_management/investor
MÉTODO
POST

Request Body

Caso 01: Pessoa Jurídica
{
"name": "Empresa Exemplo S.A.",
"document_number": "12.345.678/0001-95",
"trading_name": "Exemplo Comércio",
"cnae_code": "62.02-3-00",
"company_type": "sa",
"foundation_date": "2000-01-01",
"address": {
"street": "Rua das Empresas",
"neighborhood": "Centro",
"number": "123",
"postal_code": "01001-000",
"city": "São Paulo",
"state": "SP",
"complement": "Sala 101"
}
}
Caso 02: Pessoa Física
{
"person_type": "natural",
"name": "Maria Exemplo da Silva",
"document_number": "123.456.789-00",
"document_identification_number": "12.345.678-9",
"marital_status": "single",
"property_system": null,
"birthdate": "1990-05-14",
"nationality": "BRA",
"mother_name": "Joana Exemplo da Silva",
"father_name": "José Exemplo da Silva",
"occupation": "engenheira de software",
"is_pep": false,
"email": "maria.exemplo@example.com",
"phone_number": "+5511999999999",
"investor_category": "retail",
"investment_suitability": "moderate",
"address": {
"street": "Rua Exemplo",
"neighborhood": "Centro",
"number": "45",
"postal_code": "01001-000",
"city": "São Paulo",
"state": "SP",
"complement": "Apto 12"
}
}
Atenção

Se o campo person_type for omitido, o cadastro é tratado como Pessoa Jurídica (legal). Para cadastrar um investidor Pessoa Física, envie person_type: "natural".

Request Body Params — Pessoa Jurídica

CampoTipoDescriçãoCaracteres Máx.
person_typestringOpcional. Se omitido, o cadastro é tratado como Pessoa Jurídica (legal).Enumeradores person_type
name *stringNome completo da empresa.255
document_number *stringCNPJ da empresa (formato "XX.XXX.XXX/XXXX-XX").14
trading_name*stringNome fantasia da empresa.1023
cnae_code*stringCódigo CNAE da empresa (formato "XXXXX-XXX").7
company_type*stringTipo da empresa.Enumeradores company_type
foundation_date*stringData de fundação da empresa (formato "YYYY-MM-DD").-
address *objectObjeto referenciando o endereçoObjeto address

Request Body Params — Pessoa Física

CampoTipoDescriçãoCaracteres Máx.
person_type *stringDeve ser enviado como "natural".Enumeradores person_type
name *stringNome completo do investidor.255
document_number *stringCPF do investidor (formato "XXX.XXX.XXX-XX").14
document_identification_number*stringNúmero do documento de identidade do investidor (RG, CNH ou passaporte).255
marital_status*stringEstado civil do investidor.Enumeradores marital_status
property_systemstringRegime de bens. Obrigatório apenas quando marital_status exigir regime de bens.Enumeradores property_system
birthdate*stringData de nascimento do investidor (formato "YYYY-MM-DD").-
nationality*stringNacionalidade do investidor.Enumeradores nationality
mother_name*stringNome da mãe do investidor.1023
father_name*stringNome do pai do investidor.1023
occupation*stringOcupação/profissão do investidor.255
is_pep*booleanIndica se o investidor é uma Pessoa Politicamente Exposta.-
email*stringE-mail de contato do investidor.1023
phone_number*stringTelefone de contato do investidor.20
investor_categorystringCategoria autodeclarada do investidor. Opcional.Enumeradores investor_category
investment_suitabilitystringPerfil de suitability autodeclarado do investidor. Opcional.Enumeradores investment_suitability
address *objectObjeto referenciando o endereçoObjeto address

Objeto Address

CampoTipoDescriçãoCaracteres Máx.
street *stringNome da rua do endereço.500
neighborhood *stringNome do bairro do endereço.100
number *stringNúmero do endereço.10
postal_code *stringCEP do endereço (formatação "XXXXX-XXX").8
city *stringNome da cidade do endereço.255
state *stringSigla do estado (2 caracteres).2
complementstringComplemento do endereço, se aplicável.100

Enumeradores company_type

EnumDescription
ltdaLimitada
saSociedade Anônima
copCooperativa

Enumeradores marital_status

EnumDescription
singleSolteiro(a)
marriedCasado(a)
divorcedDivorciado(a)
widowedViúvo(a)
separatedSeparado(a)

Enumeradores property_system

EnumDescription
total_communion_of_goodsComunhão universal de bens
partial_communion_of_goodsComunhão parcial de bens
total_separation_of_goodsSeparação total de bens
final_participation_of_acquisitionsParticipação final nos aquestos
compulsory_separation_of_goodsSeparação obrigatória de bens

Enumeradores nationality

Lista completa de códigos ISO 3166-1 alpha-3 (ex.: BRA para Brasil, USA para Estados Unidos).

Enumeradores investor_category

EnumDescription
not_applicableNão aplicável
retailVarejo
qualifiedQualificado
professionalProfissional

Enumeradores investment_suitability

EnumDescription
conservativeConservador
moderateModerado
boldArrojado

Response

STATUS
201
Caso 01: Pessoa Jurídica
{
"investor_key": "123e4567-e89b-12d3-a456-426614174000",
"name": "Empresa Exemplo S.A.",
"document_number": "12.345.678/0001-95",
"status": "in_filling",
"person_type": "legal",
"trading_name": "Exemplo Comércio",
"cnae_code": "62.02-3-00",
"company_type": "sa",
"foundation_date": "2000-01-01",
"address": {
"street": "Rua das Empresas",
"neighborhood": "Centro",
"number": "123",
"postal_code": "01001-000",
"city": "São Paulo",
"state": "SP",
"complement": "Sala 101"
},
"registration_datetime": "2023-01-01T12:00:00Z",
"expiration_date": "2024-01-01T12:00:00Z"
}
Caso 02: Pessoa Física
{
"investor_key": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
"name": "Maria Exemplo da Silva",
"document_number": "123.456.789-00",
"status": "in_filling",
"person_type": "natural",
"document_identification_number": "12.345.678-9",
"marital_status": "single",
"birthdate": "1990-05-14",
"nationality": "BRA",
"occupation": "engenheira de software",
"is_pep": false,
"investor_category": "retail",
"investment_suitability": "moderate",
"address": {
"street": "Rua Exemplo",
"neighborhood": "Centro",
"number": "45",
"postal_code": "01001-000",
"city": "São Paulo",
"state": "SP",
"complement": "Apto 12"
},
"registration_datetime": "2023-01-01T12:00:00Z",
"expiration_date": "2024-01-01T12:00:00Z",
"investor_contact_information_list": [
{
"investor_contact_information_key": "3f1e2d3c-4b5a-6978-8899-aabbccddeeff",
"name": "Maria Exemplo da Silva",
"document_number": "123.456.789-00",
"email": "maria.exemplo@example.com",
"phone_number": "+5511999999999",
"is_default": true
}
],
"signer_group_list": [
{
"signer_group_key": "7a6b5c4d-3e2f-1a0b-9c8d-1234567890ab",
"minimum_required_signers": 1,
"signers": [
{
"name": "Maria Exemplo da Silva",
"document_number": "123.456.789-00",
"email": "maria.exemplo@example.com",
"phone_number": "+5511999999999",
"is_group_mandatory": true
}
]
}
]
}
Informação

investor_contact_information_list e signer_group_list só são retornados quando o cadastro é feito com acesso completo (data_access_type == full_access).

Response Body Params

CampoTipoPessoaDescriçãoCaracteres Máx.
investor_keystringAmbosChave única do investidor (UUID).36
namestringAmbosNome completo (PF) ou razão social (PJ).255
document_numberstringAmbosCPF (PF) ou CNPJ (PJ) do investidor.14
statusstringAmbosStatus do investidor.-
person_typestringAmbosTipo de pessoaEnumeradores person_type
trading_namestringSomente PJNome fantasia do investidor.1023
cnae_codestringSomente PJCódigo CNAE do investidor.7
company_typestringSomente PJTipo da empresaEnumeradores company_type
foundation_datestringSomente PJData de fundação do investidor.-
document_identification_numberstringSomente PFNúmero do documento de identidade do investidor.255
marital_statusstringSomente PFEstado civil do investidor.Enumeradores marital_status
birthdatestringSomente PFData de nascimento do investidor.-
nationalitystringSomente PFNacionalidade do investidor.Enumeradores nationality
occupationstringSomente PFOcupação/profissão do investidor.255
is_pepbooleanSomente PFIndica se o investidor é PEP.-
investor_categorystringSomente PFCategoria autodeclarada do investidor.Enumeradores investor_category
investment_suitabilitystringSomente PFPerfil de suitability autodeclarado.Enumeradores investment_suitability
addressobjectAmbosObjeto referenciando o endereçoObjeto address
investor_contact_information_listarraySomente PFLista de informações de contato do investidor. Apenas com data_access_type == full_access.-
signer_group_listarraySomente PFLista de grupos de assinantes do investidor. Apenas com data_access_type == full_access.-
registration_datetimestringAmbosData e hora de registro do investidor.-
expiration_datestringAmbosData de expiração do investidor.-

Enumeradores person_type

EnumDescription
legalPessoa Jurídica
naturalPessoa Física