List investors
Introduction
This resource lists the investors linked to your integration, with optional filters and pagination.
Input / Output
There is no request body. The filters are passed via query string, all optional.
As output, the list of investors matching the given filters is returned.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | Granted by the integration team |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/investor_registry/investorsMETHOD
GETSTATUS
200Query Params
All parameters are optional.
| Param | Type | Default | Description |
|---|---|---|---|
document_number | string | — | Full document (exact match) |
status | string | — | Investor status (see Investor Status) |
status_in | string | — | Comma-separated list of statuses |
status_not_in | string | — | Comma-separated list of statuses to exclude |
last_analysis_status_in | string | — | Statuses of the most recent registration analysis, comma-separated |
name | string | — | Part of the name (case-insensitive) |
expires_before | date | — | Registrations that expire before this date (YYYY-MM-DD) |
expires_after | date | — | Registrations that expire after this date (YYYY-MM-DD) |
order_by | string | — | created_at or updated_at. Without this parameter, most recent first |
order_direction | string | desc | asc or desc |
limit | int | 100 | Items per page (min. 0, max. 500) |
page | int | 0 | Page; the offset is calculated as page * limit |
Response
Response Body
{
"data": [
{
"name": "investidor 1",
"status": "registered",
"person_type": "natural_person",
"investor_key": "UUID v4",
"document_number": "969.698.790-03",
"email": "investidor1@exemplo.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "999990001"
},
"current_analysis": {
"investor_analysis_key": "UUID v4",
"status": "analysis_complete"
},
"distributor": {
"distributor_key": "UUID v4",
"name": "Distribuidora XYZ",
"document_number": "33444555000181",
"registry_configuration": {}
}
},
{
"name": "investidor 2",
"status": "pending_analysis",
"person_type": "natural_person",
"investor_key": "UUID v4",
"email": "investidor2@exemplo.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "999990002"
},
"distributor": {
"distributor_key": "UUID v4",
"name": "Distribuidora XYZ",
"document_number": "33444555000181",
"registry_configuration": {}
}
}
],
"limit": 100,
"page": 0,
"is_last_page": true
}
Response Params
| Field | Type | Description |
|---|---|---|
data | array | List of Investor objects |
limit | int | Number of items per page used in the query |
page | int | Returned page |
is_last_page | boolean | Indicates whether this is the last page of results |
Investor
| Field | Type | Description |
|---|---|---|
investor_key | string | Unique identification key of the investor |
name | string | Name (or corporate name) of the investor |
status | string | Current investor status |
person_type | string | Person type (natural_person or legal_person) |
email | string | Investor contact e-mail |
phone | object | Investor contact phone, in the Phone format |
document_number | string | Investor CPF or CNPJ |
current_analysis | object | Summary of the current registration analysis: investor_analysis_key, status and, when present, investor_category, suitability and investor_sub_type |
registry_expiration_date | string | Registration expiration date, when present |
distributor | object | Distributor object |
Consultant
For the consultant, each item in data carries the full investor object, in the same format as Query Investor Information. The fields above describe the response for the manager.
Distributor
| Field | Type | Description |
|---|---|---|
distributor_key | string | Unique key of the distributor |
name | string | Distributor name |
document_number | string | Distributor CNPJ |
registry_configuration | object | Distributor registration settings |
Investor Status
| Enumerator | Description |
|---|---|
created | Created |
pending_analysis | With a registration analysis in progress |
pending_documents | Waiting for documents |
pending_signer_group | Waiting for signer group |
incomplete | Incomplete registration |
registered | Registration approved and completed |
registry_expired | Registration expired |
non_operational | Non-operational |
pre_operational | Pre-operational |
inactive | Inactive |
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | — | limit above 500 or negative page |
Authentication, permission and host errors: see API Errors.