POST Sign file with certificate

Changed on

Assina um ou mais documentos via API com um certificado digital .pfx enviado na própria requisição ou, se nenhum for enviado, com o certificado cadastrado para o usuário do token (ou o certificado da plataforma, na falta dele).

Como funciona:

  • Cada item de signatures[] recebe o selo visual na página e posição informadas; com rubric: true o selo é aplicado em todas as páginas e page é dispensado.
  • Todas as document keys são validadas antes do processamento, mas um erro no meio do lote deixa os documentos anteriores assinados (não há reversão).
  • Cada documento é marcado como Signed e suas solicitações pendentes são canceladas. Documentos Word são convertidos para PDF antes de assinar. Diferente de POST /api/files/sign, este endpoint não dispara webhooks.
  • stamp personaliza os textos do selo e funciona em modo tudo ou nada: name, reason, date_label e date_format são obrigatórios em conjunto; email é opcional. Sem stamp, o selo padrão é usado.
  • O certificado enviado é usado apenas nesta requisição e descartado em seguida.

Envie como multipart/form-data (campos aninhados no formato signatures[0][document_key], signatures[0][page], stamp[name]...). Em caso de sucesso a resposta é 201 Created.

post/api/files/sign/certificate

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/files/sign/certificate
  • Auth
    API key in header Authorization

Request body multipart/form-data

certificatestring binary

Arquivo do certificado digital .pfx (PKCS12). Opcional: sem ele a API usa o certificado cadastrado para o usuário do token ou, na falta dele, o certificado da plataforma.

certificate_passwordstring

Senha do certificado enviado. Obrigatória quando certificate é enviado.

Response

Assinaturas realizadas

messagestring
file_urlsstring[]

URLs de download dos documentos assinados, na ordem de signatures[].

Changes