Query paginated investor data

---

Introduction

This resource allows listing investors applying optional filters (document, status and name), with pagination.

Input / Output

There is no request body. Filters are passed via query string, all optional.

As output, the list of investors matching the provided filters is returned.

Request

ENDPOINT

/investor_registry/investors

METHOD

GET

STATUS

200

Query Params

All parameters are optional.

Param	Type	Default	Description
document_number	string	None	Filter by complete document
status	string	None	Filter by status
name	string	None	Filter by name
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": "approved",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "email": "investidor1@exemplo.com",
            "phone": "11999990001",
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "00000000000191",
                "registry_configuration": {}
            }
        },
        {
            "name": "investidor 2",
            "status": "pending",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "email": "investidor2@exemplo.com",
            "phone": "11999990002",
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "00000000000191",
                "registry_configuration": {}
            }
        }
    ],
    "limit": 50,
    "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	Investor's unique identification key
name	string	Investor's name (or company name)
status	string	Investor's current status
person_type	string	Person type (natural_person or legal_person)
email	string	Investor's contact email
phone	string	Investor's contact phone
distributor	object	Distributor object

Distributor

Field	Type	Description
distributor_key	string	Distributor's unique key
name	string	Distributor's name
document_number	string	Distributor's CNPJ
registry_configuration	object	Distributor's registry configuration