Skip to main content

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
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiGranted by the integration team

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/investor_registry/investors
METHOD
GET
STATUS
200

Query Params​

All parameters are optional.

ParamTypeDefaultDescription
document_numberstring—Full document (exact match)
statusstring—Investor status (see Investor Status)
status_instring—Comma-separated list of statuses
status_not_instring—Comma-separated list of statuses to exclude
last_analysis_status_instring—Statuses of the most recent registration analysis, comma-separated
namestring—Part of the name (case-insensitive)
expires_beforedate—Registrations that expire before this date (YYYY-MM-DD)
expires_afterdate—Registrations that expire after this date (YYYY-MM-DD)
order_bystring—created_at or updated_at. Without this parameter, most recent first
order_directionstringdescasc or desc
limitint100Items per page (min. 0, max. 500)
pageint0Page; 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​

FieldTypeDescription
dataarrayList of Investor objects
limitintNumber of items per page used in the query
pageintReturned page
is_last_pagebooleanIndicates whether this is the last page of results

Investor​

FieldTypeDescription
investor_keystringUnique identification key of the investor
namestringName (or corporate name) of the investor
statusstringCurrent investor status
person_typestringPerson type (natural_person or legal_person)
emailstringInvestor contact e-mail
phoneobjectInvestor contact phone, in the Phone format
document_numberstringInvestor CPF or CNPJ
current_analysisobjectSummary of the current registration analysis: investor_analysis_key, status and, when present, investor_category, suitability and investor_sub_type
registry_expiration_datestringRegistration expiration date, when present
distributorobjectDistributor 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​

FieldTypeDescription
distributor_keystringUnique key of the distributor
namestringDistributor name
document_numberstringDistributor CNPJ
registry_configurationobjectDistributor registration settings

Investor Status​

EnumeratorDescription
createdCreated
pending_analysisWith a registration analysis in progress
pending_documentsWaiting for documents
pending_signer_groupWaiting for signer group
incompleteIncomplete registration
registeredRegistration approved and completed
registry_expiredRegistration expired
non_operationalNon-operational
pre_operationalPre-operational
inactiveInactive

Errors​

StatusCodeWhen it happens
400—limit above 500 or negative page

Authentication, permission and host errors: see API Errors.