Consulta de Investidores por filtros

Este endpoint permite consultar investidores cadastrados no sistema utilizando o número de documento (CNPJ) ou Nome.

---

Request

ENDPOINT

/investor_management/investor

MÉTODO

GET

Query Params

Campo	Tipo	Descrição	Obrigatório
document_number	string	Número do documento do investidor.	Não
name	string	Nome do investidor.	Não
page	integer	Página atual da consulta.	Não
rows_per_page	integer	Número de registros por página.	Não

Response

STATUS

200

Response Body

{
  "data": [
    {
        "investor_key": "495ae701-5c38-49b1-b517-a3b910fe8d8f",
        "name": "Empresa Exemplo S.A.",
        "document_number": "12.345.678/0001-95",
        "status": "in_filling"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 100,
    "total_pages": 1,
    "total_rows": 1
  }
}

Response Body Params

Campo	Tipo	Descrição
data	list	Lista de resultados	Objeto Investidor Simplificado
pagination	object	Dados de paginação	Objeto Paginação

Objeto Investidor Simplificado

Campo	Tipo	Descrição	Máximo de Caracteres
investor_key	string	Identificador único do investidor (UUID v4).	36
name	string	Nome completo do investidor.	255
document_number	string	Número do documento do investidor (CNPJ).	14
status	string	Status atual do investidor.	Enumeradores status

Enumeradores status

Enum	Description
in_filling	Em preenchimento
in_analysis	Em análise
canceled	Cancelado
approved	Aprovado
reproved	Reprovado
expired	Expirado

Objeto Pagination

Campo	Tipo	Descrição
current_page	integer	Página atual da consulta.
next_page	integer	Próxima página, caso exista.
rows_per_page	integer	Número de registros por página.
total_pages	integer	Número total de páginas.
total_rows	integer	Número total de registros encontrados.