Envio e Remoção de Grupos de Assinantes de Representantes de Partes Relacionadas

Este conjunto de endpoints permite o envio e a remoção de grupos de assinantes associados a representantes de partes relacionadas a uma operação.

---

Envio de Grupo de Assinantes (POST)

Request

ENDPOINT

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

MÉTODO

POST

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 (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

Campo	Tipo	Descrição	Caracteres Máx.
minimum_required_signers *	integer	Número mínimo de assinantes necessários no grupo.	-
signers *	array	Lista de assinantes do grupo.	Objeto signers

---

Objeto signers

Campo	Tipo	Descrição	Caracteres Máx.
name *	string	Nome completo do assinante.	255
document_number *	string	CPF do assinante (11 dígitos).	11
email *	string	Endereço de e-mail do assinante.	1023
phone_number *	string	Número de telefone do assinante, incluindo DDI.	20
is_group_mandatory *	boolean	Indica se o assinante é obrigatório.	-

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

Campo	Tipo	Descrição	Caracteres Máx.
signer_group_key *	string	Chave única do grupo de assinantes (UUID v4).	36
minimum_required_signers *	integer	Número mínimo de assinantes no grupo.	-
signers *	array	Lista de assinantes do grupo.	Objeto signers

---

Remoção de Grupo de Assinantes (DELETE)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEY/signer_group/SIGNER-GROUP-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 (UUID v4).	36
SIGNER-GROUP-KEY *	string	Chave única do grupo de assinantes.	36

Response

STATUS

204

Nenhum conteúdo é retornado no corpo da resposta.