Skip to main content

Cadastro Básico do Investidor

Este endpoint permite cadastrar as informações básicas de um investidor.

Request

ENDPOINT
/investor_management/investor
MÉTODO
POST

Request Body

Request Body
{
"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"
}
}

Request Body Params

CampoTipoDescriçãoCaracteres Máx.
name *stringNome completo da empresa.255
document_number *stringCNPJ da empresa (somente números).14
trading_namestringNome fantasia da empresa.1023
cnae_codestringCódigo CNAE da empresa (7 dígitos).7
company_typestringTipo da empresa.Enumeradores company_type
foundation_datestringData de fundação da empresa (formato "YYYY-MM-DD").-
address *stringObjeto referenciando o endereçoObjeto address

Objeto Address

CampoTipoDescriçãoCaracteres Máx.
street *stringNome da rua do endereço da empresa.500
neighborhoodstringNome do bairro do endereço da empresa.100
number *stringNúmero do endereço.10
postal_code *stringCEP do endereço (somente números).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

Response

STATUS
201
Response Body
{
"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"
}

Response Body Params

CampoTipoDescriçãoCaracteres Máx.
investor_keystringChave única do investidor (UUID).36
namestringNome completo do investidor.255
document_numberstringCNPJ do investidor.14
statusstringStatus do investidor.-
person_typestringTipo de pessoaEnumeradores person_type
trading_namestringNome fantasia do investidor.1023
cnae_codestringCódigo CNAE do investidor.7
company_typestringTipo da empresaEnumeradores company_type
foundation_datestringData de fundação do investidor.-
addressstringObjeto referenciando o endereçoObjeto address
registration_datetimestringData e hora de registro do investidor.-
expiration_datestringData de expiração do investidor.-

Enumeradores person_type

EnumDescription
legalPessoa Jurídica
naturalPessoa Física