Skip to main content

Paginated Investor Query


Request

ENDPOINT
/quota_distributor/investors
METHOD
GET
STATUS
200

Query Params

ParameterDescription
document_numberInvestor document
Warning

During the integration process, a means of authenticating the sent hash will be required.

Case 01: Return with only one investor
{
"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

FieldTypeDescription
investor_keystringUnique investor identification key
namestringInvestor name
document_numberstringInvestor CPF or CNPJ
person_typestringInvestor type (natural person for individual or legal person for legal entity)
statusstringInvestor status (approved for approved, pending update for pending update)
associationsarrayList of Association objects related to the investor
distributorJSONDistributor object representing the investor's distributor
account_dataJSONAccount Data object containing the investor's banking information
investor_sub_typestringInvestor subtype (person, financial institution or fund class)

Association

Note: Can be associated with only a manager, distributor, or both

FieldTypeDescription
managerJSONManager object representing the associated manager
distributorJSONDistributor object representing the associated distributor

Manager

FieldTypeDescription
manager_keystringUnique manager identification key
namestringManager name
document_numberstringManager CNPJ

Distributor

FieldTypeDescription
distributor_keystringUnique distributor identification key
document_numberstringDistributor CNPJ
namestringDistributor name
account_dataJSONAccount Data object with distributor's banking information

Account Data

FieldTypeDescription
account_digitstringAccount digit
account_branchstringAccount branch
account_numberstringAccount number
financial_institution_codestringFinancial institution code
financial_institution_ispbstringFinancial institution ISPB

Owner

FieldTypeDescription
namestringAccount holder name
document_numberstringAccount holder CPF or CNPJ