Solicitações de Assinatura de Documentos

Este endpoint permite enviar solicitações de assinatura em documentos para múltiplos destinatários (e-mails ou telefones). Todos os signatários assinarão o mesmo documento. Abaixo, explicamos o processo e fornecemos detalhes sobre como configurar campos e dados necessários.

Enviar solicitações sem local definido

Para configurar uma solicitação sem local definido é necessário atribuir os valores -999 aos campos xPos e yPos. Veja o exemplo abaixo:

Resultado Final

Quando você solicita uma assinatura sem especificar o local, a assinatura será inserida em uma página extra gerada após o documento. Nessa página, serão exibidos todos os dados do usuário e a assinatura gerada.

Importante: Quando se solicita assinaturas de convidados, o sistema não armazena os dados ou a assinatura do signatário. Portanto, será necessária uma página extra para cada signatário. Se houver 4 signatários, o documento terá 4 páginas extras, cada uma com a assinatura de um signatário.

Enviar documento com rubrica

Para adicionar uma rubrica, defina o campo type como rubric dentro de fields. Essa configuração irá adicionar uma posição de assinatura em todas as páginas, conforme as posições definidas. Lembre-se de que cada signatário pode usar a rubrica apenas uma vez.

O tipo rubric funciona de maneira semelhante ao image, com a diferença de que não é necessário fornecer o campo "page".

Enviar documento com texto

Ao enviar um documento com o tipo text dentro de fields, é possível utilizar os campos validateData e default:

• default: Define um valor padrão que será automaticamente preenchido no campo, desde que o validateData seja diferente de 1.
• validateData: Não preenche automaticamente o campo com o valor do default, mas valida se o usuário inseriu o valor correspondente.

Ambos os campos são opcionais. Se não forem definidos, o comportamento do sistema permanecerá o mesmo.

Regras do envio:

• Cada destinatário precisa de fields com pelo menos um campo, exceto quando signatureTag é informado (a posição da assinatura é obtida pelas tags do PDF).
• Tipos de campo: signature, rubric, text e os campos de escolha checkbox, radio e list. Para text, os campos text, color e fontsize são obrigatórios; para os campos de escolha, text (rótulo) e options são obrigatórios e default/validateData não são permitidos. Para rubric, use page: 0 para repetir em todas as páginas.
• certificate e certificate_timestamp podem ser enviados no nível raiz (valem para todos) ou por destinatário. O carimbo de tempo só é aceito com certificado 2 ou 3, destinatários com certificado 0/1 precisam vir antes dos 2/3 na cadeia, e há limites mensais de assinaturas com certificado e de carimbos por empresa (422 ao exceder).
• recipients[].doubleauth_cpf define o CPF que o signatário deve confirmar para acessar o documento; exige doubleauth: true.
• recipients[].reminder dispara imediatamente um lembrete (e-mail ou WhatsApp) e só vale para o primeiro signatário da cadeia.
• due_months é aceito, mas não é gravado neste formato (a resposta traz 0).
• Um sender com id inexistente é ignorado e o usuário do token passa a ser o remetente.

Formatos da resposta: envio normal: data + message + deliveries; com silent_mode: data + message + silent_mode (lista de URLs de assinatura); com chain: false e mais de um destinatário, data é uma lista com uma solicitação por destinatário.