发送投资者地址
简介
本资源旨在发送构成投资者注册分析的地址。
基金类别(
fund_class)——跳过此步骤基金类别无需发送地址。在提交分析时,地址会自动继承自与该类别关联的管理机构,且对该子类型,submit 不要求 address 块。请跳过此步骤。
Input / Output
作为输入,发送地址数据。
作为输出,将返回分析的 data 对象,其中包含已保存的注册数据块。
适用范围
| 角色 | 主机 |
|---|---|
| 投资者 | investor-api |
各主机的 Base URL:环境(主机)。
Request
ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/addressMÉTODO
PUTSTATUS
202示例
请求体
{
"street": "Avenida Paulista",
"number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"postal_code": "01310-100",
"uf": "SP",
"country": "BRA",
"complement": "Sala 1010"
}
Body params
| 字段 | 类型 | 描述 | 字符数 | 必填 |
|---|---|---|---|---|
street | string | 街道 | 1 - 255 | 是 |
number | string | 门牌号(仅限数字) | 1 - 10 | 是 |
neighborhood | string | 街区 | 1 - 255 | 是 |
city | string | 城市 | 1 - 255 | 是 |
postal_code | string | 邮政编码。在巴西为 NNNNN-NNN 格式的 CEP;在境外为所在国家的本地格式 | 1 - 20 | 是 |
uf | string | 联邦州——例如:SP、CE、MG。境外地址使用 EX | 1 - 20 | 是 |
country | string | 国家 ISO 代码,3 位字母——例如:BRA、PRT | 3 | 是 |
complement | string | 地址补充信息 | 1 - 255 | 否 |
境外地址
country、uf 和 postal_code 的校验取决于分析的居民身份:
分析的 resident | country | uf | postal_code |
|---|---|---|---|
true(默认) | 必须为 BRA(IVR000227) | 巴西联邦州代码——例如:SP、RJ(IVR000273) | NNNNN-NNN 格式的 CEP,8 位数字含连字符(IVR000281) |
false | 除 BRA 外的任意值(IVR000226) | 不做格式校验 | 不做格式校验 |
对于境外地址,postal_code 和 uf 接受任何国家的格式(各最多 20 个字符):葡萄牙邮编 1000-001 或美国 ZIP 10001 均按原样接受。
居民身份在创建投资者时确定
resident 不是此步骤的字段,且之后无法修改。如果发送境外地址时收到 IVR000227,说明该分析创建时即为居民——需要按照创建投资者页面中非居民投资者一节的说明,使用 resident: false 和 non_resident_type 创建投资者。
Response
响应体返回分析的 data 对象,其中包含已保存的数据块。状态及其他字段请参阅查询投资者注册分析信息。
错误
| 状态 | 代码 | 发生情形 |
|---|---|---|
| 400 | IVR000018 | 分析已不处于 pending_registry_data 状态(已提交或已结束) |
| 400 | IVR000227 | 居民投资者的 country 不是 BRA |
| 400 | IVR000226 | 非居民投资者的 country 为 BRA |
| 400 | IVR000273 | 居民投资者的 uf 不是巴西联邦州代码 |
| 400 | IVR000281 | 居民投资者的 CEP 不符合 NNNNN-NNN 格式 |
| 400 | QIT000011 | 通过管理人(manager-api)调用时:该投资者不是与其关联的基金类别 |
认证、权限和主机相关错误:参见 API 错误。