Send Subscriber Groups

---

Introduction

This feature aims to define the subscriber groups that will be responsible for signing the investor's documents.

Input / Output:

As input, an array of subscriber groups should be sent, each group containing signatories and the minimum number of signatures required.

As output, an investor_key and an investor_analysis_key will be delivered.

Request

ENDPOINT

/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/signer_groups

METHOD

PUT

STATUS

202

Request body

Example

Request Body

[
    {
        "is_default": true,
        "minimum_required_signers": 2,
        "expiration_date": "2025-12-31",
        "signers": [
            {
                "name": "João Silva",
                "document_number": "123.456.789-00",
                "email": "joao.silva@example.com",
                "is_required_signer": true
            },
            {
                "name": "Maria Santos",
                "document_number": "987.654.321-00",
                "email": "maria.santos@example.com",
                "is_required_signer": true
            },
            {
                "name": "Pedro Oliveira",
                "document_number": "456.789.123-00",
                "email": "pedro.oliveira@example.com",
                "is_required_signer": false
            }
        ]
    }
]

Body params

Field	Type	Description	Characters	Required
is_default	boolean	Defines if this is the default group	-	Yes
minimum_required_signers	number	Minimum number of signers required	-	Yes
expiration_date	string	Expiration date of the subscriber group (format: YYYY-MM-DD)	10	No
signers	array	List of signatories	-	Yes

Signers

Field	Type	Description	Characters	Required
name	string	Signatory name	1 - 255	Yes
document_number	string	CPF or CNPJ of the signatory	14 - 18	Yes
email	string	Signatory email	1 - 512	Yes
is_required_signer	boolean	Defines if the signatory is required	-	Yes

Information

• The is_default parameter defines if this is the default subscriber group. Only one group can be marked as default.
• The minimum_required_signers must be less than or equal to the total number of signatories in the group.
• The is_required_signer indicates if the signatory is mandatory within the group. At least one signatory must have is_required_signer: true.
• The expiration_date is optional and defines the expiration date of the subscriber group. After this date, the group can no longer be used for document signing.

Response

Response Body

{
    "investor_key": "UUID",
    "investor_analysis_key": "UUID"
}

---