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_groupMETHOD
POSTPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Unique 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
| Field | Type | Description | Max Characters |
|---|---|---|---|
minimum_required_signers * | integer | Minimum number of signers required in the group. | - |
signers * | array | List of group signers. | signers Object |
signers Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
name * | string | Full name of the signer. | 255 |
document_number * | string | Signer's CPF (11 digits). | 11 |
email * | string | Signer's email address. | 1023 |
phone_number * | string | Signer's phone number, including country code. | 20 |
is_group_mandatory * | boolean | Indicates if the signer is mandatory. | - |
Response
STATUS
201Response 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
| Field | Type | Description | Max Characters |
|---|---|---|---|
signer_group_key * | string | Unique signer group key (UUID v4). | 36 |
minimum_required_signers * | integer | Minimum number of signers in the group. | - |
signers * | array | List 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-KEYMETHOD
DELETEPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Unique related party key (UUID v4). | 36 |
SIGNER-GROUP-KEY * | string | Unique signer group key. | 36 |
Response
STATUS
204No content is returned in the response body.