Related Party Registration and Removal

This set of endpoints allows registering and removing related parties to an operation.

warning

All related parties are added by default to the Constitutive Term (commercial_paper). If you want to add this related party to a specific document, fill the related_document_key field with the key of the desired document.

---

Related Party Registration (POST)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/related_party

METHOD

POST

Path Params

Field	Type	Description	Max Characters
OPERATION-KEY *	string	Unique operation key (UUID v4).	36

Important

Attention to person type when building the payload:

• Natural Person: "person_type": "natural"
• Legal Person: "person_type": "legal"

Request Body - Natural Person

{
  "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 - Legal Person

{
  "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

Field	Type	Description	Max Characters
person_type *	string	Person type.	person_type Enumerators
name *	string	Related party name.	255
document_number *	string	CPF (format "XXX.XXX.XXX-XX") or CNPJ (format "XX.XXX.XXX/XXXX-XX").	14
street *	string	Address street.	500
neighborhood	string	Address neighborhood.	100
number *	string	Address number.	10
postal_code *	string	Address postal code (format "XXXXX-XXX").	8
city *	string	Address city.	255
state *	string	State abbreviation (2 characters).	2
role_type *	string	Related party role.	role_type Enumerators
related_document_key	string	Document identification key (UUIDv4)	36

person_type Enumerators

Enum	Description
natural	Natural Person
legal	Legal Person

Additional fields for Natural Person

Field	Type	Description	Max Characters
document_identification_number	string	ID number (without formatting)	20
marital_status	string	Marital status.	marital_status Enumerators
property_system	string	Property regime.	property_system Enumerators
birthdate	string	Birth date (YYYY-MM-DD).	-
nationality	string	Nationality.	255
mother_name	string	Mother's name.	255
father_name	string	Father's name.	255
occupation	string	Occupation.	255
is_pep *	boolean	Indicates if the related party is a Politically Exposed Person (PEP).

Additional fields for Legal Person

Field	Type	Description	Max Characters
trading_name *	string	Company trade name.	1023
cnae_code *	string	Company CNAE code (10 digits).	10
company_type *	string	Company type.	company_type Enumerators
foundation_date *	string	Foundation date (YYYY-MM-DD).	-

role_type Enumerators

Enum	Description
cosigner	Cosigner
fiduciary_debtor	Fiduciary Debtor
solidary_debtor	Solidary Debtor
guarantor	Guarantor
bonafide_depositary	Bona Fide Depositary
intervening_guarantor	Intervening Guarantor
intervening_consentor	Intervening Consenter
intervening_discharger	Intervening Discharger
assignor	Assignor
endorser	Endorser
consulting	Consultant
fund_administrator	Fund Administrator
fund_representative	Fund Representative
company_representative	Company Representative
attestant	Witness
debtor	Debtor
bestowal	Spousal Authorization
manager	Manager

marital_status Enumerators

Enum	Description
single	Single
married	Married
divorced	Divorced
widowed	Widowed
separated	Separated
stable_union	Stable Union

property_system Enumerators

Enum	Description
total_communion_of_goods	Total Community of Property
partial_communion_of_goods	Partial Community of Property
total_separation_of_goods	Total Separation of Property
final_participation_of_acquisitions	Final Participation in Acquisitions
compulsory_separation_of_goods	Compulsory Separation of Property

company_type Enumerators

Enum	Description
ltda	Limited Liability Company
sa	Corporation
cop	Cooperative

Response

STATUS

201

Response 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

Field	Type	Description	Max Characters
related_party_key *	string	Unique related party key.	36
name *	string	Related party name.	255
document_number *	string	Related party CPF/CNPJ.	14
role_type *	string	Related party role.	50
is_active *	boolean	Indicates if it is active.	-
updated_at	string	Last update date (YYYY-MM-DD HH:mm:ss).	-
person_type *	string	Person type.	person_type Enumerators
street *	string	Street.	500
neighborhood	string	Neighborhood.	100
number *	string	Number.	10
postal_code *	string	Postal code (numbers only).	8
city *	string	City.	255
state *	string	State abbreviation (2 characters).	2

---

Related Party Removal (DELETE)

Request

ENDPOINT

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

METHOD

DELETE

Path Params

Field	Type	Description	Max Characters
OPERATION-KEY *	string	Unique operation key (UUID v4).	36
RELATED-PARTY-KEY *	string	Unique related party key.	36

Response

STATUS

204

No content is returned in the response body.