Skip to main content

Related Party Representative Signer Group Upload and Removal

This set of endpoints allows uploading and removing signer groups associated with related party representatives to an operation.


Signer Group Upload (POST)​

Request​

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEY/signer_group
METHOD
POST

Path Params​

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
RELATED-PARTY-KEY *stringUnique related party key (UUID v4).36
Request Body
{
"minimum_required_signers": 2,
"signers": [
{
"name": "João da Silva",
"document_number": "12345678901",
"email": "joao.silva@example.com",
"phone_number": "+5511999999999",
"is_group_mandatory": true
},
{
"name": "Maria Souza",
"document_number": "98765432100",
"email": "maria.souza@example.com",
"phone_number": "+5511988888888",
"is_group_mandatory": false
}
]
}

Request Body Params​

FieldTypeDescriptionMax Characters
minimum_required_signers *integerMinimum number of signers required in the group.-
signers *arrayList of group signers.signers Object

signers Object​

FieldTypeDescriptionMax Characters
name *stringFull name of the signer.255
document_number *stringSigner's CPF (11 digits).11
email *stringSigner's email address.1023
phone_number *stringSigner's phone number, including country code.20
is_group_mandatory *booleanIndicates if the signer is mandatory.-

Response​

STATUS
201
Response Body
{
"signer_group_key": "123e4567-e89b-12d3-a456-426614174000",
"minimum_required_signers": 2,
"signers": [
{
"name": "João da Silva",
"document_number": "12345678901",
"email": "joao.silva@example.com",
"phone_number": "+5511999999999",
"is_group_mandatory": true
},
{
"name": "Maria Souza",
"document_number": "98765432100",
"email": "maria.souza@example.com",
"phone_number": "+5511988888888",
"is_group_mandatory": false
}
]
}

Response Body Params​

FieldTypeDescriptionMax Characters
signer_group_key *stringUnique signer group key (UUID v4).36
minimum_required_signers *integerMinimum number of signers in the group.-
signers *arrayList of group signers.signers Object

Signer Group Removal (DELETE)​

Request​

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEY/signer_group/SIGNER-GROUP-KEY
METHOD
DELETE

Path Params​

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
RELATED-PARTY-KEY *stringUnique related party key (UUID v4).36
SIGNER-GROUP-KEY *stringUnique signer group key.36

Response​

STATUS
204

No content is returned in the response body.