Paginated query of investors by fund class

Returns, in a paginated way, the investors who have a financial application linked to the provided fund class (through issuance series and subclasses). It allows filtering by document, name and the fund's accounting date.

Request

ENDPOINT

/quota/fund_class/{fund_class_key}/investors

METHOD

GET

Query params

Parameter	Type	Required	Description
page	integer	optional	Page number (starts at 0).
limit	integer	optional	Records per page. Default: 20. Maximum: 500.
document_number	string	optional	Filters by the investor's document with punctuation.
reference_date	string (date)	optional	Restricts to records where the accounting date of the fund class (accounting_date) is equal to the provided date (the date format accepted by the server for date parameters, typically YYYY-MM-DD).

Example call

GET /quota/fund_class/{fund_class_key}/investors?page=0&limit=25&reference_date=2024-04-01

Response

STATUS

200

Response Body

{
  "data": [
    {
      "distributor": {
        "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
        "document_number": "12.345.678/0001-90",
        "name": "Distribuidora Exemplo S.A.",
        "account_data": {
          "owner": {
            "name": "Distribuidora Exemplo S.A.",
            "document_number": "12.345.678/0001-90"
          },
          "account_digit": "1",
          "account_branch": "0001",
          "account_number": "12345",
          "financial_institution_code": "341",
          "financial_institution_ispb": "60746948"
        }
      },
      "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Maria Cotista Silva",
      "person_type": "natural_person",
      "document_number": "123.456.789-00",
      "external_id": "ext-inv-001",
      "external_distribution_key": null
    },
    {
      "distributor": {
        "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
        "document_number": "12.345.678/0001-90",
        "name": "Distribuidora Exemplo S.A.",
        "account_data": {
          "owner": {
            "name": "Distribuidora Exemplo S.A.",
            "document_number": "12.345.678/0001-90"
          },
          "account_digit": "1",
          "account_branch": "0001",
          "account_number": "12345",
          "financial_institution_code": "341",
          "financial_institution_ispb": "60746948"
        }
      },
      "investor_key": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "Investimentos PJ Ltda",
      "person_type": "legal_person",
      "document_number": "98.765.432/0001-10",
      "external_id": null,
      "external_distribution_key": "dist-key-7721"
    }
  ],
  "limit": 20,
  "page": 0,
  "is_last_page": true
}

Response attributes

Field	Type	Description
data	array	List of investors.
page	integer	Current page.
limit	integer	Page size.
is_last_page	boolean	Indicates the end of the pagination.

Fields of each investor in data

Field	Type	Description
investor_key	string	Unique identifier of the investor (UUID).
name	string	Name.
person_type	string	Person type (enumerator, e.g. natural_person, legal_person).
document_number	string	Document, when there is one.
distributor	object	Data of the distributor (distributor_key, document_number, name, account_data).
external_id	string	Optional — external identifier.
external_distribution_key	string	Optional — external distribution key.

Possible errors

STATUS

404

Fund class not found

{
  "title": " Fund Class not Found",
  "description": "Fund Class with key {fund_class_key} was not found.",
  "translation": "A classe com chave {fund_class_key} não foi encontrado.",
  "code": "QTA000002"
}