Definir grupos de signatários
Last updated
Was this helpful?
Last updated
Was this helpful?
Grupos de signatários permitem definir diferentes conjuntos de pessoas que devem assinar um documento, com possibilidade de configurar uma ordem de assinatura entre os grupos. A definição de grupos agora é feita diretamente no payload do endpoint de criação de documentos, sem necessidade de chamadas adicionais. Como configurar grupos de signatários no payload de criação de documento Utilize os seguintes campos para configurar os grupos e a ordem de assinatura:
signature_order_active
: define se a ordem de assinatura será sequencial (true para ativar).
order_group
: número que representa a ordem de assinatura do grupo (ex: 1, 2, 3...).
POST
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Body
name
string
Nome do documento
url_pdf
string
URL do PDF a ser assinado
external_id
string
ID externo para controle do cliente
signers
Array
Lista de signatários
send_automatic
boolean
Envia automaticamente após a criação
lang
string
Idioma do fluxo (pt
, en
, es
, ...)
disable_signer_emails
boolean
Desativa o envio de e-mails aos signatários
brand_logo
string
URL do logotipo personalizado (opcional)
brand_primary_color
string
Cor principal personalizada (ex: #000000
)
brand_name
string
Nome da marca exibido
created_by
string
E-mail de quem criou o documento
date_limit_to_sign
string (ISO8601)
Data limite para assinatura (YYYY-MM-DDTHH:mm:ssZ
)
signature_order_active
boolean
Define se há ordem de assinatura entre grupos
observers
Array
Lista de e-mails de observadores
reminder_every_n_days
number
Envia lembrete a cada N dias (opcional)
allow_refuse_signature
boolean
Permite recusar assinatura
disable_signers_get_original_file
boolean
Impede que signatários acessem o PDF final
Propriedades de signers
name
string
Nome do signatário
string
E-mail do signatário
auth_mode
string
Modo de autenticação (ex: assinaturaTela
)
order_group
number
Número do grupo sequencial. Grupos com mesmo número assinam juntos
custom_message
string
Mensagem personalizada que será enviada ao signatário no corpo do e-mail
phone_country
string
Código do país do telefone (ex: "55"
)
phone_number
string
Número do telefone
require_cpf
boolean
Define se o CPF será obrigatório
cpf
string
CPF do signatário
send_automatic_email
boolean
Envia automaticamente e-mail de assinatura
send_automatic_whatsapp
boolean
Envia automaticamente WhatsApp (se suportado)
lock_email
boolean
Bloqueia edição do e-mail na interface do signatário
Respostas