分页查询投资者数据

---

Introduction

此功能允许通过可选筛选条件（证件号码、状态和姓名）列出投资者，并支持分页。

Input / Output

无请求体。筛选条件通过 query string 传递，全部为可选。

输出将返回符合所提供筛选条件的投资者列表。

Request

ENDPOINT

/investor_registry/investors

MÉTODO

GET

STATUS

200

Query Params

所有参数均为可选。

Param	类型	默认值	描述
document_number	string	None	按完整证件号码筛选
status	string	None	按状态筛选
name	string	None	按姓名筛选
limit	int	100	每页条数（最小 0，最大 500）
page	int	0	页码；偏移量按 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

字段	类型	描述
data	array	Investor 对象列表
limit	int	查询中使用的每页条数
page	int	返回的页码
is_last_page	boolean	是否为结果的最后一页

Investor

字段	类型	描述
investor_key	string	投资者的唯一标识键
name	string	投资者姓名（或公司名称）
status	string	投资者的当前状态
person_type	string	人员类型（natural_person 或 legal_person）
email	string	投资者的联系邮箱
phone	string	投资者的联系电话
distributor	object	Distributor 对象

Distributor

字段	类型	描述
distributor_key	string	分销商的唯一标识键
name	string	分销商名称
document_number	string	分销商的 CNPJ
registry_configuration	object	分销商的注册配置