POST Sign file with certificate

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
signatures
array of objects
required
length ≥ 1

Lista de assinaturas (um item por documento/posição).

signatures*
string
required

Document Key do arquivo (precisa pertencer à sua empresa).

integer
≥ 1

Página em que a assinatura será inserida. Obrigatória quando rubric não é true.

number
required

Posição no eixo X onde a assinatura será inserida.

number
required

Posição no eixo Y onde a assinatura será inserida.

boolean

Quando true, todas as páginas do documento são assinadas na posição especificada, dispensando page.

file

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.

string

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

stamp
object

Textos personalizados do selo visual. Ao informar stamp, name, reason, date_label e date_format são obrigatórios (até 120 caracteres cada); email é opcional.

Responses

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