Issuer Signer Groups Registration

This endpoint allows registering signer groups associated with a previously registered issuer.

---

Request

ENDPOINT

/issuer_management/issuer/ISSUER-KEY/signer_group

METHOD

POST

Path Params

Field	Type	Description	Characters
ISSUER-KEY	string	Unique issuer key (UUID v4).	36

Request Body

Request Body

{
  "minimum_required_signers": 2,
  "signers": [
    {
      "name": "João da Silva",
      "document_number": "123.456.789-01",
      "email": "joao.silva@email.com",
      "phone_number": "+5511999999999",
      "is_group_mandatory": true
    },
    {
      "name": "Maria Souza",
      "document_number": "123.456.789-01",
      "email": "maria.souza@email.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 to validate the group.	-
signers *	array	List of Signer Objects that make up the signer group	Signer Object

Signer Object

Field	Type	Description	Max Characters
name *	string	Full name of the signer.	255
document_number *	string	Signer's CPF (format "XXX.XXX.XXX-XX").	11
email *	string	Signer's email address.	1023
phone_number*	string	Signer's phone number (complete format: country code, area code and number. Example: +5511999999999).	20
is_group_mandatory *	boolean	Indicates if the signer is mandatory or optional within the group.	-

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": "123.456.789-01",
      "email": "joao.silva@email.com",
      "phone_number": "+5511999999999",
      "is_group_mandatory": true
    },
    {
      "name": "Maria Souza",
      "document_number": "123.456.789-01",
      "email": "maria.souza@email.com",
      "phone_number": "+5511988888888",
      "is_group_mandatory": false
    }
  ]
}

Response Body Params

Field	Type	Description	Max Characters
signer_group_key	string	Unique identifier of the signer group (UUID v4).	36
minimum_required_signers	integer	Minimum number of signers required in the group.	-
signers *	array	List of Signer Objects that make up the signer group	Signer Object