Cadastro Básico do Investidor
Este endpoint permite cadastrar as informações básicas de um investidor.
Request
ENDPOINT
/investor_management/investorMÉTODO
POSTRequest 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
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
name * | string | Nome completo da empresa. | 255 |
document_number * | string | CNPJ da empresa (somente números). | 14 |
trading_name | string | Nome fantasia da empresa. | 1023 |
cnae_code | string | Código CNAE da empresa (7 dígitos). | 7 |
company_type | string | Tipo da empresa. | Enumeradores company_type |
foundation_date | string | Data de fundação da empresa (formato "YYYY-MM-DD"). | - |
address * | string | Objeto referenciando o endereço | Objeto address |
Objeto Address
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
street * | string | Nome da rua do endereço da empresa. | 500 |
neighborhood | string | Nome do bairro do endereço da empresa. | 100 |
number * | string | Número do endereço. | 10 |
postal_code * | string | CEP do endereço (somente números). | 8 |
city * | string | Nome da cidade do endereço. | 255 |
state * | string | Sigla do estado (2 caracteres). | 2 |
complement | string | Complemento do endereço, se aplicável. | 100 |
Enumeradores company_type
Enum | Description |
---|---|
ltda | Limitada |
sa | Sociedade Anônima |
cop | Cooperativa |
Response
STATUS
201Response 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
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
investor_key | string | Chave única do investidor (UUID). | 36 |
name | string | Nome completo do investidor. | 255 |
document_number | string | CNPJ do investidor. | 14 |
status | string | Status do investidor. | - |
person_type | string | Tipo de pessoa | Enumeradores person_type |
trading_name | string | Nome fantasia do investidor. | 1023 |
cnae_code | string | Código CNAE do investidor. | 7 |
company_type | string | Tipo da empresa | Enumeradores company_type |
foundation_date | string | Data de fundação do investidor. | - |
address | string | Objeto referenciando o endereço | Objeto address |
registration_datetime | string | Data e hora de registro do investidor. | - |
expiration_date | string | Data de expiração do investidor. | - |
Enumeradores person_type
Enum | Description |
---|---|
legal | Pessoa Jurídica |
natural | Pessoa Física |