查询投资者信息

简介

本资源旨在提供投资者的数据。

输入/输出：

本资源没有作为输入的body，只需在 path 中传递投资者标识键（investor_key）。

作为输出，将返回我们系统中该投资者每项数据的表示。以下是示例。

Request

ENDPOINT

/investor_registry/v2/investor/{investor_key}

MÉTODO

GET

STATUS

200

Responses

情况01：法人投资者 - 投资基金

{
   "investor_key":"UUID",
   "name":"Sample Investor Name",
   "document_number":"000.000.000-00",
   "status":"pending_analysis",
   "email":"sample@mail.com.br",
   "person_type":"natural_person",
   "phone":{
      "number":"123456789",
      "area_code":"11",
      "international_dial_code":"055"
   },
   "distributor":{
      "distributor_key":"UUID",
      "name":"Sample Distributor Name",
      "document_number":"00.000.000/0000-00"
   },
   "analyses":[
      {
         "investor_analysis_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "analysis_datetime":"2024-11-25 13:42:40.003782",
         "status":"pending_registry_data"
      }
   ],
   "document_batches":[
      {
         "document_batch_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "status":"creating_documents | pending_signer_groups | send_to_signature | pending_signature",
         "documents":[
            {
               "investor_document_key":"UUID",
               "type":" cnh | rg | rg_back | rg_front | proof_of_residence | cnpj_card | financial_statements | power_of_attorney | billing_statement | social_contract |qualified_investor_term | professional_investor_term | natural_person_registry_form | legal_person_registry_form ",
               "status":"generated"
            }
         ]
      }
   ],
   "status_events":[
      {
         "status":"pending_analysis",
         "event_datetime":"2024-11-25 13:42:40.013357"
      }
   ],
}

情况02：法人投资者待注册分析

{
   "investor_key":"UUID",
   "name":"Sample Investor Name",
   "document_number":"00.000.000/0000-00 | 000.000.000-00",
   "status":"pending_analysis",
   "person_type":"legal_person",
   "distributor":{
      "distributor_key":"UUID",
      "name":"Sample Distributor Name",
      "document_number":"00.000.000/0000-00"
   },
   "email":"sample@mail.com.br",
   "phone":{
      "number":"123456789",
      "area_code":"11",
      "international_dial_code":"055"
   },
   "analyses":[
      {
         "investor_analysis_key":"UUID",
         "agent_key":"UUID",
         "analysis_datetime":"2024-11-25 13:08:25.649543",
         "status":"pending_registry_data",
         "registry_user":{
            "registry_user_key":"UUID",
            "kc_user_id":"UUID",
            "name":"Sample Investor Name",
            "document_number":"000.000.000-00",
            "email":"sample@email.com.br",
            "phone":{
               "number":"123456789",
               "area_code":"11",
               "international_dial_code":"055"
            }
         }
      }
   ],
   "document_batches":[
      {
         "document_batch_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "status":"creating_documents | send_to_signature | pending_signature",
         "documents":[
            {
               "investor_document_key":"UUID",
               "type":" cnh | rg | rg_back | rg_front | proof_of_residence | cnpj_card | financial_statements | power_of_attorney | billing_statement | social_contract |qualified_investor_term | professional_investor_term | natural_person_registry_form | legal_person_registry_form ",
               "status":"sent_to_generate | generated"
            }
         ]
      }
   ],
   "status_events":[
      {
         "status":"pending_analysis",
         "event_datetime":"2024-11-25 13:08:25.673902"
      }
   ],
}

Investor

字段	类型	描述	字符数
`investor_key`	string	投资者唯一标识键	36
`name`	string	投资者姓名	最多255
`document_number`	string	投资者 CPF / CNPJ	14或18
`email`	string	投资者电子邮件	-
`phone`	string	Phone 对象	-
`status`	string	投资者注册状态枚举值	-
`person_type`	string	投资者自然人或法人枚举值	-
`distributor`	JSON	Distributor 对象	-
`analyses`	array	Investor Analysis 对象列表	-
`document_batches`	array	Document Batch 对象列表	-
`status_events`	array	Status Event 对象列表	-

Phone

字段	类型	描述	字符数
`international_dial_code`	string	国际区号	1-3
`area_code`	string	地区区号	2
`number`	string	电话号码	8-9

Investor Status

枚举值	描述
`pending_analysis`	待分析
`pending_documents`	待文件
`pending_update`	待更新
`registered`	已注册

Person Type

枚举值	描述
`natural_person`	自然人
`legal_person`	法人

Distributor

字段	类型	描述	字符数
`name`	string	分销商名称	最多255
`distributor_key`	string	分销商唯一标识键	-
`document_number`	string	分销商 CPF/CNPJ	14或18

Investor Analysis

字段	类型	描述	字符数
`investor_analysis_key`	string	投资者注册分析唯一标识键	36
`analysis_datetime`	string	注册分析创建的日期和时间	-
`status`	string	注册分析状态枚举值	-
`registry_user`	JSON	Registry User 对象	-

Document Batch

字段	类型	描述	字符数
`document_batch_key`	string	文件批次唯一标识键	36
`status`	string	文件批次状态枚举值	-
`documents`	Array	Investor Document 对象列表	-

Investor Document

字段	类型	描述	字符数
`investor_document_key`	string	投资者文件唯一标识键	36
`type`	string	投资者文件类型枚举值	-
`status`	string	投资者文件状态枚举值	-

Registry User

字段	类型	描述	字符数
`registry_user_key`	string	注册用户唯一标识键	36
`kc_user_id`	string	KeyCloak 中用户的唯一标识键	-
`name`	string	分销商名称	最多255
`document_number`	string	分销商 CPF/CNPJ	14或18
`phone`	JSON	Phone 对象	-

Investor Analysis Status

枚举值	描述
`pending_registry_data`	待注册数据
`pending_documents`	待文件
`sent_to_analysis`	已发送分析
`in_manual_analysis`	人工分析中
`approved`	已批准
`reproved`	已拒绝

Document Batch Status

枚举值	描述
`creating_documents`	创建文件中
`send_to_signature`	已发送签署
`pending_signature`	待签署

Document Type

枚举值	描述
`cnh`	CNH
`rg`	RG
`rg_back`	RG - 背面
`rg_front`	RG - 正面
`proof_of_residence`	居住证明
`cnpj_card`	CNPJ 卡
`financial_statements`	财务报表
`power_of_attorney`	授权书
`billing_statement`	收入证明
`social_contract`	章程合同
`qualified_investor_term`	合格投资者声明
`professional_investor_term`	专业投资者声明
`natural_person_registry_form`	注册表 - 自然人
`legal_person_registry_form`	注册表 - 法人

Investor Document Status

枚举值	描述
`sent_to_generate`	已发送生成
`generated`	已生成

Status Event

字段	类型	描述	字符数
`status`	string	Investor Status 枚举值	-
`event_datetime`	string	状态更新执行的日期和时间	-

简介​

输入/输出：​

Request​

Responses​

Investor​

Phone​

Investor Status​

Person Type​

Distributor​

Investor Analysis​

Document Batch​

Investor Document​

Registry User​

Investor Analysis Status​

Document Batch Status​

Document Type​

Investor Document Status​

Status Event​

简介