Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Sign file

Assina um documento via API com a conta de um dos usuários cadastrados.

Esta assinatura é indicada para usuários que possuam certificado digital cadastrado na plataforma. Neste caso, o sistema irá utilizar o certificado da conta informada no processo de assinatura.

A assinatura via API é uma assinatura invisível, o sistema não vai inserir representações gráficas da assinatura no documento, apenas realizar a assinatura eletrônica que poderá ser validada posteriormente via ITI.

Para realizar o processo é necessário definir a página e a posição da assinatura visual, que vai conter os dados do signatário e do seu certificado.

post/api/files/sign

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 na qual a assinatura será inserida. Não obrigatório quando rubric for true.

user_idinteger

Usuário para assinar o documento, caso não seja informado o sistema vai assinar pelo administrador da empresa

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"

editablevalidateinteger

Tipo de validação/QR Code aplicado ao documento.

Response

200

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"
}