登记和删除关联方
此端点集合允许在操作中登记和删除关联方。
注意
所有关联方默认会被添加到组成性条款（commercial_paper）中，如需将该关联方添加到特定文件，请在 related_document_key 字段中填写所需文件的键。
登记关联方 (POST)
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/related_partyMÉTODO
POSTPath Params
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
OPERATION-KEY * | string | 操作的唯一键（UUID v4）。 | 36 |
重要
构建 payload 时请注意人员类型：
- 自然人（PF）：
"person_type": "natural" - 法人（PJ）：
"person_type": "legal"
Request Body - 自然人（PF）
{
"person_type": "natural",
"name": "João da Silva",
"document_number": "123.731.320-10",
"street": "Rua dos Exemplos",
"neighborhood": "Centro",
"number": "123",
"postal_code": "29173-509",
"city": "São Paulo",
"state": "SP",
"role_type": "guarantor",
"marital_status": "single",
"birthdate": "2000-01-01",
"mother_name": "Mãe do João",
"father_name": "Pai do João",
"occupation": "Desenvolvedor",
"is_pep": false
}
Request Body - 法人（PJ）
{
"person_type": "legal",
"name": "João da Silva",
"trading_name": "Padaria do João LTDA",
"document_number": "92.123.456/0001-00",
"street": "Rua dos Exemplo",
"neighborhood": "Centro",
"number": "123",
"postal_code": "01001-000",
"city": "São Paulo",
"state": "SP",
"role_type": "guarantor",
"cnae_code": "12.34-5-67",
"company_type": "ltda",
"foundation_date": "2025-01-01"
}
Request Body Params
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
person_type * | string | 人员类型。 | person_type 枚举 |
name * | string | 关联方名称。 | 255 |
document_number * | string | CPF（格式："XXX.XXX.XXX-XX"）或 CNPJ（格式："XX.XXX.XXX/XXXX-XX"）。 | 14 |
street * | string | 地址街道。 | 500 |
neighborhood | string | 地址区域。 | 100 |
number * | string | 地址门牌号。 | 10 |
postal_code * | string | 邮政编码（格式："XXXXX-XXX"）。 | 8 |
city * | string | 地址城市。 | 255 |
state * | string | 州缩写（2个字符）。 | 2 |
role_type * | string | 关联方角色。 | role_type 枚举 |
related_document_key | string | 文件标识键（UUIDv4）。 | 36 |
person_type 枚举
| 枚举值 | 描述 |
|---|---|
natural | 自然人 |
legal | 法人 |
自然人额外字段
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
document_identification_number | string | 身份证号（无格式）。 | 20 |
marital_status | string | 婚姻状况。 | marital_status 枚举 |
property_system | string | 夫妻财产制度。 | property_system 枚举 |
birthdate | string | 出生日期（YYYY-MM-DD）。 | - |
nationality | string | 国籍。 | 255 |
mother_name | string | 母亲姓名。 | 255 |
father_name | string | 父亲姓名。 | 255 |
occupation | string | 职业。 | 255 |
is_pep * | boolean | 指示关联方是否为政治公众人物（PEP）。 |
法人额外字段
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
trading_name * | string | 公司商业名称。 | 1023 |
cnae_code * | string | 公司 CNAE 代码（10位数字）。 | 10 |
company_type * | string | 公司类型。 | company_type 枚举 |
foundation_date * | string | 成立日期（YYYY-MM-DD）。 | - |
role_type 枚举
| 枚举值 | 描述 |
|---|---|
cosigner | 共同签署人 |
fiduciary_debtor | 信托债务人 |
solidary_debtor | 连带债务人 |
guarantor | 担保人 |
bonafide_depositary | 忠实保管人 |
intervening_guarantor | 介入担保人 |
intervening_consentor | 介入同意人 |
intervening_discharger | 介入清偿人 |
assignor | 出让人 |
endorser | 背书人 |
consulting | 顾问 |
fund_administrator | 基金管理人 |
fund_representative | 基金代表 |
company_representative | 公司代表 |
attestant | 见证人 |
debtor | 债务人 |
bestowal | 配偶同意 |
manager | 管理人 |
marital_status 枚举
| 枚举值 | 描述 |
|---|---|
single | 单身 |
married | 已婚 |
divorced | 离婚 |
widowed | 丧偶 |
separated | 分居 |
stable_union | 稳定伴侣关系 |
property_system 枚举
| 枚举值 | 描述 |
|---|---|
total_communion_of_goods | 完全共同财产制 |
partial_communion_of_goods | 部分共同财产制 |
total_separation_of_goods | 完全分别财产制 |
final_participation_of_acquisitions | 婚后所得共同制 |
compulsory_separation_of_goods | 法定分别财产制 |
company_type 枚举
| 枚举值 | 描述 |
|---|---|
ltda | 有限责任公司 |
sa | 股份公司 |
cop | 合作社 |
Response
STATUS
201Response Body
{
"related_party_key": "c642a117-ea6e-4da7-a8fd-451f556e5c38",
"name": "João da Silva",
"document_number": "12345678901",
"role_type": "guarantor",
"is_active": true,
"updated_at": null,
"person_type": "natural",
"street": "Rua dos Exemplo",
"neighborhood": "Centro",
"number": "123",
"postal_code": "01001000",
"city": "São Paulo",
"state": "SP",
"signer_group_list": [],
"document_list": [],
"contact_information_list": []
}
Response Body Params
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
related_party_key * | string | 关联方的唯一键。 | 36 |
name * | string | 关联方名称。 | 255 |
document_number * | string | 关联方的 CPF/CNPJ。 | 14 |
role_type * | string | 关联方角色 。 | 50 |
is_active * | boolean | 指示是否处于活动状态。 | - |
updated_at | string | 最后更新日期（YYYY-MM-DD HH:mm:ss）。 | - |
person_type * | string | 人员类型。 | person_type 枚举 |
street * | string | 街道。 | 500 |
neighborhood | string | 区域。 | 100 |
number * | string | 门牌号。 | 10 |
postal_code * | string | 邮政编码（仅数字）。 | 8 |
city * | string | 城市。 | 255 |
state * | string | 州缩写（2个字符）。 | 2 |
删除关联方 (DELETE)
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEYMÉTODO
DELETEPath Params
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
OPERATION-KEY * | string | 操作的唯一键（UUID v4）。 | 36 |
RELATED-PARTY-KEY * | string | 关联方的唯一键。 | 36 |
Response
STATUS
204响应体中不返回任何内容。