跳到主要内容

查询投资者信息

简介​

本资源返回投资者的完整数据——包括其注册分析、文件批次、状态事件、分销商和注册用户。

Input / Output​

无请求体。标识键通过 path 传入。

作为输出，将返回投资者的当前信息。

适用范围
角色主机
分销商distributor-api

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

Request​

ENDPOINT
/investor_registry/investor/{investor_key}
MÉTODO
GET
STATUS
200
相关端点
  • 列出代理的投资者：GET /investor_registry/investors（分页，支持 name、document_number、status 过滤）。
  • 列出某 investor owner 所拥有的投资者（典型用途：fund class）：GET /investor_registry/investor/{investor_key}/investors。

Response​

案例 01：自然人
{
   "investor_key": "UUID",
   "name": "João da Silva",
   "document_number": "969.698.790-03",
   "status": "pending_analysis",
   "email": "joao@example.com",
   "person_type": "natural_person",
   "phone": {
      "number": "987654321",
      "area_code": "11",
      "international_dial_code": "55"
   },
   "distributor": {
      "distributor_key": "UUID",
      "name": "Distribuidor XPTO",
      "document_number": "33.444.555/0001-81"
   },
   "analyses": [
      {
         "investor_analysis_key": "UUID",
         "analysis_datetime": "2025-04-29 12:07:55.059999",
         "status": "pending_registry_data"
      }
   ],
   "document_batches": [],
   "status_events": [
      {
         "status": "pending_analysis",
         "event_datetime": "2025-04-29 12:07:55.000000"
      }
   ]
}
案例 02：法人——投资基金
{
   "investor_key": "UUID",
   "name": "Fundo XPTO Multimercado",
   "document_number": "22.333.444/0001-81",
   "status": "registered",
   "person_type": "legal_person",
   "investor_sub_type": "fund_class",
   "distributor": {
      "distributor_key": "UUID",
      "name": "Distribuidor XPTO",
      "document_number": "33.444.555/0001-81"
   },
   "analyses": [
      {
         "investor_analysis_key": "UUID",
         "analysis_datetime": "2025-04-29 12:07:55.059999",
         "status": "manually_approved",
         "registry_user": {
            "registry_user_key": "UUID",
            "kc_user_id": "UUID",
            "name": "João da Silva",
            "document_number": "969.698.790-03",
            "email": "joao.silva@example.com",
            "phone": {
               "number": "123456789",
               "area_code": "11",
               "international_dial_code": "55"
            }
         }
      }
   ],
   "document_batches": [
      {
         "document_batch_key": "UUID",
         "status": "signed",
         "documents": [
            {
               "investor_document_key": "UUID",
               "type": "legal_person_registry_form",
               "status": "signed"
            }
         ]
      }
   ],
   "status_events": [
      {
         "status": "registered",
         "event_datetime": "2025-04-29 13:08:25.673902"
      }
   ]
}

Investor​

字段类型描述
investor_keystring投资者唯一标识键
namestring投资者姓名（或公司名称）
document_numberstring投资者 CPF / CNPJ
emailstring联系电子邮箱
phoneobjectPhone 对象
statusstringInvestor Status 枚举值
person_typestringPerson Type 枚举值
investor_sub_typestringInvestor Sub Type 枚举值（适用时）
distributorobjectDistributor 对象
analysesarrayInvestor Analysis 对象列表
document_batchesarrayDocument Batch 对象列表
status_eventsarrayStatus Event 对象列表

Phone​

字段类型描述字符数
international_dial_codestring国际区号1 - 3
area_codestring地区区号（DDD）2
numberstring电话号码8 - 9

Investor Status​

枚举值描述
created已创建
pending_analysis待分析
pending_documents待提交文件
incomplete注册不完整
pending_update待更新
registered已注册
registry_expired注册已过期

Person Type​

枚举值描述
natural_person自然人
legal_person法人
nomineeNominee / PCO

Investor Sub Type​

枚举值描述
default普通法人
financial_institution金融机构
fund_class投资基金
non-resident非居民

Distributor​

字段类型描述
distributor_keystring分销商唯一键
namestring分销商名称
document_numberstring分销商 CNPJ

Investor Analysis​

字段类型描述
investor_analysis_keystring注册分析唯一键
analysis_datetimestring分析创建日期/时间
statusstringInvestor Analysis Status 枚举值
registry_userobjectRegistry User 对象（存在时）

Document Batch​

字段类型描述
document_batch_keystring文件批次唯一键
statusstringDocument Batch Status 枚举值
documentsarrayInvestor Document 对象列表

Investor Document​

字段类型描述
investor_document_keystring投资者文件唯一键
typestringDocument Type 枚举值
statusstringInvestor Document Status 枚举值

Registry User​

字段类型描述
registry_user_keystring注册用户唯一键
kc_user_idstring投资者访问用户的标识符
namestring姓名
document_numberstringCPF
emailstring电子邮箱
phoneobjectPhone 对象

Investor Analysis Status​

枚举值描述
created已创建
pending_registry_data待提交注册数据
pending_documents待提交文件
sent_to_analysis已提交分析
in_manual_analysis人工分析中
automatically_approved自动批准
automatically_reproved自动拒绝
manually_approved人工批准
manually_reproved人工拒绝
expired已过期

Document Batch Status​

枚举值描述
creating_documents文件生成中
send_to_signature已发送签署
pending_signature等待签署
signed已签署

Document Type​

枚举值描述
cnhCNH（驾驶证）
rgRG（身份证）
rg_backRG——背面
rg_frontRG——正面
proof_of_residence住址证明
cnpj_cardCNPJ 卡
financial_statements财务报表
social_contract公司章程（Contrato social）
company_statute公司规章（Estatuto）
board_election_record选举会议记录
fund_prospectus基金章程
power_of_attorney授权委托书
billing_statement账单 / 对账单
investor_qualification_proof投资者资格证明
qualified_investor_term合格投资者声明
professional_investor_term专业投资者声明
natural_person_registry_form注册表——自然人
legal_person_registry_form注册表——法人

Investor Document Status​

枚举值描述
sent_to_generate已发送生成
generated已生成
signed已签署

Status Event​

字段类型描述
statusstring状态枚举值
event_datetimestring事件日期/时间

错误​

状态代码发生情形
404IVR000008未找到投资者
400QIT000011该投资者未关联到您的集成

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