Paginated Investor Query
Request
ENDPOINT
/quota_distributor/investorsMETHOD
GETSTATUS
200Query Params
| Parameter | Description |
|---|---|
document_number | Investor 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
| Field | Type | Description |
|---|---|---|
investor_key | string | Unique investor identification key |
name | string | Investor name |
document_number | string | Investor CPF or CNPJ |
person_type | string | Investor type (natural person for individual or legal person for legal entity) |
status | string | Investor status (approved for approved, pending update for pending update) |
associations | array | List of Association objects related to the investor |
distributor | JSON | Distributor object representing the investor's distributor |
account_data | JSON | Account Data object containing the investor's banking information |
investor_sub_type | string | Investor subtype (person, financial institution or fund class) |
Association
Note: Can be associated with only a manager, distributor, or both
| Field | Type | Description |
|---|---|---|
manager | JSON | Manager object representing the associated manager |
distributor | JSON | Distributor object representing the associated distributor |
Manager
| Field | Type | Description |
|---|---|---|
manager_key | string | Unique manager identification key |
name | string | Manager name |
document_number | string | Manager CNPJ |
Distributor
| Field | Type | Description |
|---|---|---|
distributor_key | string | Unique distributor identification key |
document_number | string | Distributor CNPJ |
name | string | Distributor name |
account_data | JSON | Account Data object with distributor's banking information |
Account Data
| Field | Type | Description |
|---|---|---|
account_digit | string | Account digit |
account_branch | string | Account branch |
account_number | string | Account number |
financial_institution_code | string | Financial institution code |
financial_institution_ispb | string | Financial institution ISPB |
Owner
| Field | Type | Description |
|---|---|---|
name | string | Account holder name |
document_number | string | Account holder CPF or CNPJ |