Cadastro de Grupos de Assinantes do Investidor

Este endpoint permite o cadastro de grupos de assinantes associados a um investidor previamente cadastrado.

---

Request

ENDPOINT

/investor_management/investor/INVESTOR-KEY/signer_group

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres
INVESTOR-KEY	string	Chave única do investidor (UUID v4).	36

Request Body

Response 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

Campo	Tipo	Descrição	Máximo de Caracteres
minimum_required_signers *	integer	Número mínimo de assinantes necessários para validar o grupo.	-
signers *	array	Lista de Objetos Signer que compõem o grupo de assinantes	Objeto Signer

Objeto Signer

Campo	Tipo	Descrição	Máximo de Caracteres
name *	string	Nome completo do assinante.	255
document_number *	string	CPF do assinante (11 dígitos).	11
email *	string	Endereço de email 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 ou opcional dentro do grupo.	-

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

Campo	Tipo	Descrição	Máximo de Caracteres
signer_group_key	string	Identificador único do grupo de assinantes (UUID v4).	36
minimum_required_signers	integer	Número mínimo de assinantes necessários no grupo.	-
signers *	array	Lista de Objetos Signer que compõem o grupo de assinantes	Objeto Signer