按过滤条件查询投资人

此端点允许使用证件号码（CNPJ）或姓名查询系统中已登记的投资人。

---

Request

ENDPOINT

/investor_management/investor

MÉTODO

GET

Query Params

字段	类型	描述	必填
document_number	string	投资人的证件号码。	否
name	string	投资人姓名。	否
page	integer	查询的当前页码。	否
rows_per_page	integer	每页记录数。	否

Response

STATUS

200

Response Body

{
  "data": [
    {
        "investor_key": "495ae701-5c38-49b1-b517-a3b910fe8d8f",
        "name": "Empresa Exemplo S.A.",
        "document_number": "12.345.678/0001-95",
        "status": "in_filling"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 100,
    "total_pages": 1,
    "total_rows": 1
  }
}

Response Body Params

字段	类型	描述
data	list	结果列表。	简化投资人对象
pagination	object	分页数据。	分页对象

简化投资人对象

字段	类型	描述	最大字符数
investor_key	string	投资人的唯一标识符（UUID v4）。	36
name	string	投资人全名。	255
document_number	string	投资人的证件号码（CNPJ）。	14
status	string	投资人当前状态。	status 枚举

status 枚举

枚举值	描述
in_filling	填写中
in_analysis	分析中
canceled	已取消
approved	已批准
reproved	未批准
expired	已过期

分页对象

字段	类型	描述
current_page	integer	查询的当前页码。
next_page	integer	下一页（如果存在）。
rows_per_page	integer	每页记录数。
total_pages	integer	总页数。
total_rows	integer	找到的总记录数。