Consulta paginada de Investidores

---

Request

ENDPOINT

/quota_distributor/investors

MÉTODO

GET

STATUS

200

Query Params

Parâmetro	Descrição
document_number	Documento do investidor

Atenção

Durante o processo de integração será exigido um meio de autenticação da hash enviada.

Caso 01: Retorno com apenas um investidor

{
    "data": [
      {
         "investor_key":"UUID",
         "name":"SAMPLE INVESTOR NAME",
         "document_number":"00.000.000/0000-00",
         "person_type":"natural_person / legal_person",
         "status":"approved / pending_update",
         "associations":[
            {
               "manager":{
                  "manager_key":"UUID",
                  "name":"SAMPLE MANAGER NAME",
                  "document_number":"00.000.000/0000-00"
               }
            }
         ],
         "distributor":{
            "distributor_key":"UUID",
            "document_number":"00.000.000/0000-00",
            "name":"SAMPLE DISTRIBUTOR NAME",
            "account_data":{
               "owner":{
                  "name":"SAMPLE OWNER NAME",
                  "document_number":"00.000.000/0000-00"
               },
                "account_digit": "0",
                "account_branch": "0000",
                "account_number": "00000",
                "financial_institution_code": "000",
                "financial_institution_ispb": "00000000"
            }
         },
         "account_data": {
              "account_digit": "0",
              "account_branch": "0000",
              "account_number": "00000",
              "financial_institution_code": "000",
              "financial_institution_ispb": "00000000"
          },
         "investor_sub_type": "person / financial_institution / fund class"
      }
    ],
    "limit": 50,
    "page": 0,
    "is_last_page": true
}

Investor

Campo	Tipo	Descrição
investor_key	string	Chave única de identificação do investidor
name	string	Nome do investidor
document_number	string	CPF ou CNPJ do investidor
person_type	string	Tipo do investidor (natural person para pessoa física ou legal person para pessoa jurídica)
status	string	Status do investidor (approved para aprovado, pending update para atualização pendente)
associations	array	Lista de objetos de Association relacionados ao investidor
distributor	JSON	Objeto de Distributor que representa o distribuidor do investidor
account_data	JSON	Objeto de Account Data contendo informações bancárias do investidor
investor_sub_type	string	Subtipo de investidor (person, financial institution ou fund class)

Association

Obs: Pode ser associado apenas a um gestor, distribuidor ou ambos

Campo	Tipo	Descrição
manager	JSON	Objeto de Manager que representa o gestor associado
distributor	JSON	Objeto de Distributor que representa o distribuidor associado

Manager

Campo	Tipo	Descrição
manager_key	string	Chave única de identificação do gestor
name	string	Nome do gestor
document_number	string	CNPJ do gestor

Distributor

Campo	Tipo	Descrição
distributor_key	string	Chave única de identificação do distribuidor
document_number	string	CNPJ do distribuidor
name	string	Nome do distribuidor
account_data	JSON	Objeto de Account Data com informações bancárias do distribuidor

Account Data

Campo	Tipo	Descrição
account_digit	string	Dígito da conta
account_branch	string	Agência da conta
account_number	string	Número da conta
financial_institution_code	string	Código da instituição financeira
financial_institution_ispb	string	ISPB da instituição financeira

Owner

Campo	Tipo	Descrição
name	string	Nome do titular da conta
document_number	string	CPF ou CNPJ do titular