Investor Query by Filters

This endpoint allows querying investors registered in the system using document number (CNPJ) or Name.

---

Request

ENDPOINT

/investor_management/investor

METHOD

GET

Query Params

Field	Type	Description	Required
document_number	string	Investor document number.	No
name	string	Investor name.	No
page	integer	Current page of the query.	No
rows_per_page	integer	Number of records per page.	No

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

Field	Type	Description
data	list	Results list	Simplified Investor Object
pagination	object	Pagination data	Pagination Object

Simplified Investor Object

Field	Type	Description	Max Characters
investor_key	string	Unique investor identifier (UUID v4).	36
name	string	Full investor name.	255
document_number	string	Investor document number (CNPJ).	14
status	string	Current investor status.	status enumerators

status enumerators

Enum	Description
in_filling	In filling
in_analysis	Under analysis
canceled	Canceled
approved	Approved
reproved	Rejected
expired	Expired

Pagination Object

Field	Type	Description
current_page	integer	Current page of the query.
next_page	integer	Next page, if it exists.
rows_per_page	integer	Number of records per page.
total_pages	integer	Total number of pages.
total_rows	integer	Total number of records found.