Assina um documento via API com a conta de um usuário da sua empresa, usando o certificado digital cadastrado para esse usuário (validado quanto à validade) ou, na falta dele, o certificado da plataforma.

O que a assinatura faz:

  • Insere o selo visual da assinatura na página e posição informadas (ou em todas as páginas, com rubric: true) e aplica o QR Code/página de validação conforme o editablevalidate do documento.
  • Marca o documento como Signed e cancela todas as solicitações pendentes dele.
  • Dispara os webhooks REQUESTS_UPDATED e REQUESTS_CHAIN_UPDATED (com signing_key null).
  • Documentos Word são convertidos para PDF antes de assinar.

Sem user_id, a assinatura é feita com o usuário do token; com user_id, o usuário precisa estar ativo na sua empresa. Em caso de sucesso a resposta é 201 Created.

post/api/files/sign

Request

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

Request body

document_keystring required

Document Key do arquivo que será assinado via API, deve ser da empresa para o qual o token foi enviado

pageinteger

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

user_idinteger

Id do usuário (ativo na sua empresa) que assinará. Se omitido, assina o usuário do token.

xPosnumber float required

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

yPosnumber float required

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

rubricboolean

Quando definido como True, todas as páginas do documento serão assinadas na posição especificada, não sendo necessário fornecer o campo "page"

Response

Documento assinado

messagestring

Mensagem de confirmação retornada pela API.

file_urlstring

URL para download do documento assinado.

Example response

{
  "message": "Assinatura feita com sucesso!",
  "file_url": "https://app.plugsign.com.br/api/files/download/document_key"
}

Changes

    • breaking

      removed the success response with the status

    • warning

      removed the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status