Consulta paginada de investidores por classe de fundo

Retorna investidores que possuem aplicação financeira vinculada à classe de fundo informada (via séries de emissão e subclasses), de forma paginada. Permite filtrar por documento, nome e data contábil do fundo.

Request

ENDPOINT

/quota/fund_class/{fund_class_key}/investors

MÉTODO

GET

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
page	integer	opcional	Número da página (começa em 0).
limit	integer	opcional	Registros por página. Padrão: 20. Máximo: 500.
document_number	string	opcional	Filtra pelo documento do investidor com pontuação.
reference_date	string (data)	opcional	Restringe a registros em que a data contábil da classe de fundo (accounting_date) é igual à data informada (formato aceito pelo servidor para parâmetros de data, tipicamente YYYY-MM-DD).

Exemplo de chamada

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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "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
}

Atributos da resposta

Campo	Tipo	Descrição
data	array	Lista de investidores.
page	integer	Página atual.
limit	integer	Tamanho da página.
is_last_page	boolean	Indica fim da paginação.

Campos de cada investidor em data

Campo	Tipo	Descrição
investor_key	string	Identificador único do investidor (UUID).
name	string	Nome.
person_type	string	Tipo de pessoa (enumerador, ex.: natural_person, legal_person).
document_number	string	Documento, quando houver.
distributor	object	Dados da distribuidora (distributor_key, document_number, name, account_data).
external_id	string	Opcional — identificador externo.
external_distribution_key	string	Opcional — chave de distribuição externa.

Possíveis erros

STATUS

404

Classe de fundo não encontrada

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