Enviar Grupos de Assinantes
Introdução
Este recurso tem como objetivo definir os grupos de assinantes que serão responsáveis por assinar os documentos do investidor.
Input / Output:
Como input deve ser enviado um array de grupos de assinantes, cada grupo contendo signatários e o número mínimo de assinaturas necessárias.
Como output será entregue uma investor_key e uma investor_analysis_key.
Request
ENDPOINT
/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/signer_groupsMÉTODO
PUTSTATUS
202Request body
Exemplo
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
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
is_default | boolean | Define se este é o grupo padrão | - | Sim |
minimum_required_signers | number | Número mínimo de assinantes necessários | - | Sim |
expiration_date | string | Data de expiração do grupo de assinantes (formato: YYYY-MM-DD) | 10 | Não |
signers | array | Lista de signatários | - | Sim |
Signers
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
name | string | Nome do signatário | 1 - 255 | Sim |
document_number | string | CPF ou CNPJ do signatário | 14 - 18 | Sim |
email | string | E-mail do signatário | 1 - 512 | Sim |
is_required_signer | boolean | Define se o signatário é obrigatório | - | Sim |
Informação
- O parâmetro
is_defaultdefine se este é o grupo padrão de assinantes. Apenas um grupo pode ser marcado como padrão. - O
minimum_required_signersdeve ser menor ou igual ao número total de signatários no grupo. - O
is_required_signerindica se o signatário é obrigatório dentro do grupo. Pelo menos um signatário deve teris_required_signer: true. - O
expiration_dateé opcional e define a data de expiração do grupo de assinantes. Após esta data, o grupo não poderá mais ser utilizado para assinatura de documentos.
Response
Response Body
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}