POST Send Lote Requests

Com esse método é possível enviar um lote de documentos para assinatura.

Com o uso de lotes, você pode agrupar e enviar vários documentos de uma só vez, otimizando o processo de coleta de assinaturas.

Ideal para fluxos em que múltiplos documentos precisam ser assinados simultaneamente por um ou mais participantes.

Comportamentos importantes:

  • Se subject e message não forem informados no destinatário, valem os valores da raiz; sem nenhum dos dois, a mensagem padrão é Você foi convidado para assinar um lote de documentos.
  • certificate aqui é booleano (não há níveis 0 a 3 nem certificate_timestamp como no envio por documento).
  • fullname, cpf e birthdate não são validados pela API.
  • Se signature_type não existir, o papel do signatário fica null.
  • Formato legado, sem recipients: email[] e message obrigatórios, com subject, expire_date, due_months, chain e silent_mode opcionais.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

Lote ID usado na solicitação.

boolean
Defaults to true

Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo.

string

Identifica o colaborador remetente da solicitação. Informe o ID do usuário ou o e-mail de um usuário pertencente à mesma empresa. Se omitido, utiliza o usuário autenticado.

String ou integer .

observer
array of strings

Lista de e-mails dos observadores da solicitação. Os observadores recebem comunicações relacionadas ao andamento do processo de assinatura.

observer
integer

A validade do documento em meses, por exemplo, um contrato com 12 meses de validade. Nós iremos monitorar a data e avisaremos antes do vencimento, para que possam refazer a solicitação e reenviar para assinatura.

boolean
Defaults to false

Quando true, a solicitação é criada sem enviar notificações por e-mail, WhatsApp ou lembretes. A resposta retorna a lista silent_mode com a URL de assinatura e o contato de cada destinatário.

number

Largura da página em pixels, usada como referência de escala na hora de calcular as posições dos campos de assinatura e texto (fields).

Campo opcional. Regras:

  • Com width_page: é necessário enviar fields com as posições dos campos.
  • Sem width_page: não envie fields — a assinatura será posicionada automaticamente em uma página final gerada automaticamente pelo sistema, ao fim do documento.
recipients
array of objects
required

Destinatários

recipients*
string

Assunto padrão do e-mail, usado pelos destinatários que não informarem subject.

string

Mensagem padrão, usada pelos destinatários que não informarem message. Padrão: "Você foi convidado para assinar um lote de documentos".

boolean

Exige certificado digital de todos os destinatários (equivale a definir recipients[].certificate em cada um).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json