Cadastro e Remoção de Partes Relacionadas

Este conjunto de endpoints permite o cadastro e a remoção de partes relacionadas a uma operação.

---

Cadastro de Parte Relacionada (POST)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/related_party

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres Máx.
OPERATION-KEY *	string	Chave única da operação (UUID v4).	36

Request Body

{
  "person_type": "natural",
  "name": "João da Silva",
  "document_number": "12345678901",
  "street": "Rua dos Exemplo",
  "neighborhood": "Centro",
  "number": "123",
  "postal_code": "01001000",
  "city": "São Paulo",
  "state": "SP",
  "role_type": "guarantor",
  "is_pep": false
}

Request Body Params

Campo	Tipo	Descrição	Caracteres Máx.
person_type *	string	Tipo da pessoa.	Enumeradores person_type
name *	string	Nome da parte relacionada.	255
document_number *	string	CPF (11 dígitos) ou CNPJ (14 dígitos) (somente números).	14
street *	string	Logradouro do endereço.	500
neighborhood	string	Bairro do endereço.	100
number *	string	Número do endereço.	10
postal_code *	string	CEP do endereço (somente números, 8 dígitos).	8
city *	string	Cidade do endereço.	255
state *	string	Sigla do estado (2 caracteres).	2
role_type *	string	Papel da parte relacionada.	Enumeradores role_type
is_pep *	boolean	Indica se a parte relacionada é uma Pessoa Politicamente Exposta (PEP).	-

Campos adicionais para Pessoa Física

Campo	Tipo	Descrição	Caracteres Máx.
document_identification_number	string	RG.	20
marital_status	string	Estado civil.	Enumeradores marital_status
property_system	string	Regime de bens.	Enumeradores property_system
birthdate	string	Data de nascimento (YYYY-MM-DD).	-
nationality	string	Nacionalidade.	255
mother_name	string	Nome da mãe.	255
father_name	string	Nome do pai.	255
occupation	string	Ocupação.	255

Campos adicionais para Pessoa Jurídica

Campo	Tipo	Descrição	Caracteres Máx.
trading_name *	string	Nome fantasia da empresa.	1023
cnae_code *	string	Código CNAE da empresa (10 dígitos).	10
company_type *	string	Tipo da empresa.	Enumeradores company_type
foundation_date *	string	Data de fundação (YYYY-MM-DD).	-

Response

STATUS

201

Response Body

{
	"related_party_key": "c642a117-ea6e-4da7-a8fd-451f556e5c38",
	"name": "Fernando Ferreira",
	"document_number": "89106778640",
	"role_type": "cosigner",
	"is_active": true,
	"updated_at": null,
	"person_type": "natural",
	"street": "Rua das Flores",
	"neighborhood": "Centro",
	"number": "123",
	"postal_code": "12345678",
	"city": "São Paulo",
	"state": "SP",
	"signer_group_list": [],
	"document_list": [],
	"contact_information_list": []
}

Response Body Params

Campo	Tipo	Descrição	Caracteres Máx.
related_party_key *	string	Chave única da parte relacionada.	36
name *	string	Nome da parte relacionada.	255
document_number *	string	CPF/CNPJ da parte relacionada.	14
role_type *	string	Papel da parte relacionada.	50
is_active *	boolean	Indica se está ativa.	-
updated_at	string	Data da última atualização (YYYY-MM-DD HH:mm:ss).	-
person_type *	string	Tipo da pessoa.	Enumeradores person_type
street *	string	Logradouro.	500
neighborhood	string	Bairro.	100
number *	string	Número.	10
postal_code *	string	CEP (somente números).	8
city *	string	Cidade.	255
state *	string	Sigla do estado (2 caracteres).	2

---

Remoção de Parte Relacionada (DELETE)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEY

MÉTODO

DELETE

Path Params

Campo	Tipo	Descrição	Caracteres Máx.
OPERATION-KEY *	string	Chave única da operação (UUID v4).	36
RELATED-PARTY-KEY *	string	Chave única da parte relacionada.	36

Response

STATUS

204

Nenhum conteúdo é retornado no corpo da resposta.