跳到主要内容

创建投资者


简介​

本资源用于向我们提供启动投资者注册所需的基本数据。

创建投资者时,会同时开启一份与之关联的首个注册分析。因此,此调用结束时会返回两个键:investor_key(标识投资者)和 investor_analysis_key(标识进行中的注册分析)。

Sandbox 中的审批规则

在 Sandbox 中,分析结果取决于 CPF/CNPJ 的首位数字:以 1 开头 → 自动拒绝;以 8 开头 → 人工分析;其余自动批准。

Input / Output​

输入为投资者的基本数据。必填字段因 person_type 和 investor_sub_type 而异。

输出将返回 investor_key 和 investor_analysis_key。investor_key 标识投资者;investor_analysis_key 标识随创建一同开启的注册分析。同一投资者在不同时间可以拥有多份注册分析(续期、更新)。

适用范围
角色主机
投资者investor-api

各主机的 Base URL:环境(主机)。

Request​

ENDPOINT
/investor_registry/investor
MÉTODO
POST
STATUS
201

Request body​

案例 01:自然人
请求体
{
"name": "João da Silva",
"document_number": "969.698.790-03",
"person_type": "natural_person",
"email": "joao.silva@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "987654321"
},
"investor_owner_type": "wallet_manager"
}
案例 02:法人
请求体
{
"name": "Empresa XPTO Ltda",
"document_number": "22.333.444/0001-81",
"person_type": "legal_person",
"investor_sub_type": "default",
"investor_owner_type": "wallet_manager"
}
必填字段

必填字段随 person_type 变化。缺少其中任何一个都会被拒绝并返回 IVR000009。

  • natural_person:name、document_number、person_type;未发送 investor_owner_type 时,还需 email 和 phone
  • legal_person:name、document_number、person_type

对投资组合管理人而言,investor_owner_type 为必填:未发送时,请求会被拒绝并返回 IVR000153。发送该字段后,natural_person 无需提供 email 和 phone。

investor_sub_type 为可选;non_resident 会被拒绝并返回 IVR000255。

Body params​

字段类型描述字符数必填
namestring投资者姓名(或公司名称)1 - 255是
person_typestringPerson Type 枚举值-是
document_numberstringCPF(XXX.XXX.XXX-XX)或 CNPJ(XX.XXX.XXX/XXXX-XX)14 或 18是*
investor_sub_typestringInvestor Sub Type 枚举值-否
emailstring投资者邮箱。未发送 investor_owner_type 的 natural_person 必填1 - 255条件必填
phoneobjectPhone 对象。未发送 investor_owner_type 的 natural_person 必填-条件必填
investor_owner_typestring与所创建投资者的关系类型 - Investor Owner Type 枚举值1 - 255是

Phone​

字段类型描述字符数必填
international_dial_codestring国际区号(例如 55)1 - 3是
area_codestring地区区号(DDD)2是
numberstring电话号码8 - 9是

Person Type​

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

Investor Sub Type​

枚举值描述
default普通法人(未填写该字段时的默认值)

Investor Owner Type​

枚举值描述
wallet_manager投资组合管理人

Response​

响应体
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}

错误​

状态代码发生情形
400IVR000004CPF/CNPJ 校验位无效,或 CPF 搭配 legal_person 发送(反之亦然)
400IVR000009缺少该 person_type 的必填字段
400IVR000153未发送 investor_owner_type
400IVR000255investor_sub_type: non_resident。请使用 resident: false 和 non_resident_type
400IVR000258 / IVR000259对属于已登记金融机构或 CVM 类别的 CNPJ 声明了子类型 default
409IVR000007您已使用此证件注册过投资者

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