列出投资者

---

简介

此资源列出与您的集成关联的投资者，支持可选筛选条件和分页。

Input / Output

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

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

适用范围

角色	主机	所需权限
管理人	manager-api	读取
顾问	consultant-api	由集成团队开通

各主机的 Base URL：环境（主机）。

Request

ENDPOINT

/investor_registry/investors

MÉTODO

GET

STATUS

200

Query Params

所有参数均为可选。

Param	类型	默认值	描述
document_number	string	—	完整证件号码（精确匹配）
status	string	—	投资者状态（见 Investor Status）
status_in	string	—	以逗号分隔的状态列表
status_not_in	string	—	要排除的状态列表，以逗号分隔
last_analysis_status_in	string	—	最近一次注册分析的状态，以逗号分隔
name	string	—	姓名的一部分（不区分大小写）
expires_before	date	—	在此日期之前到期的注册（YYYY-MM-DD）
expires_after	date	—	在此日期之后到期的注册（YYYY-MM-DD）
order_by	string	—	created_at 或 updated_at。不传此参数时，最新的排在前面
order_direction	string	desc	asc 或 desc
limit	int	100	每页条数（最小 0，最大 500）
page	int	0	页码；偏移量按 page * limit 计算

Response

响应体

{
    "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

字段	类型	描述
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	object	投资者的联系电话，格式见 Phone
document_number	string	投资者的 CPF 或 CNPJ
current_analysis	object	当前注册分析的摘要：investor_analysis_key、status，以及存在时的 investor_category、suitability 和 investor_sub_type
registry_expiration_date	string	注册到期日（如有）
distributor	object	Distributor 对象

顾问

对于顾问，data 中的每一项都是完整的投资者对象，格式与查询投资者信息相同。上表描述的是管理人收到的响应。

Distributor

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

Investor Status

枚举值	描述
created	已创建
pending_analysis	注册分析进行中
pending_documents	等待文件
pending_signer_group	等待签署人组
incomplete	注册不完整
registered	注册已批准并完成
registry_expired	注册已过期
non_operational	非运营
pre_operational	预运营
inactive	未激活

错误

状态	代码	发生情形
400	—	limit 超过 500 或 page 为负数

认证、权限和主机相关错误：参见 API 错误。