v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Send request with template

O envio de solicitação de assinatura com templates é mais simples do que o envio com documentos, uma vez que não é necessário definir os campos (pois já foram definidos no upload).

Porém, é importante se atentar a um ponto fundamental: o envio com templates é INDIVIDUAL. Portanto, se você passar 3 e-mails no array "emails", o sistema vai gerar 3 documentos únicos e enviar um para cada e-mail, de forma que cada signatário assinará um documento distinto.

Lembre-se também que o template original não será assinado. Em vez disso, serão assinadas as cópias geradas com base no modelo original.

post/api/requests/templates

Request body

document_keystring required

A document_key do template que será enviado.

senderstring

Identifica o colaborador que aparecerá como remetente deste documento. Pode ser o ID do usuário ou o e-mail dele. Se omitido, o documento será enviado pela conta do admin da empresa.

observerstring[]

Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails

silent_modeboolean

Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados

due_monthsinteger

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

auto_resendboolean

Quando o documento estiver prestes a vencer, o sistema usará o template original para gerar um novo documento e reenviá-lo ao usuário.

Response

200

messagestring

Mensagem de confirmação retornada pela API após o envio da solicitação.

Example response

{
  "data": {
    "id": 1658323,
    "signing_key": "iQ01s1dpvEruKFqCVxcqM592Rv5m4Vsf",
    "document": "1Fj9M1dFOvV0i9krYc7LY1lkn1aBVoto",
    "email": "exemplo@hotmail.com",
    "message": "teste",
    "positions": "[\"1215.98\",{\"type\":\"image\",\"page\":\"1\",\"xPos\":\"648.5\",\"yPos\":\"78\",\"width\":\"200\",\"height\":\"75\",\"fontsize\":null,\"group\":\"input\",\"isRubric\":\"undefined\"}]",
    "signature_type": "all",
    "sender": {
      "id": 122,
      "name": "Teste",
      "last_name": "Costa",
      "email": "exemplo2@hotmail.com",
      "phone": "989999999",
      "permissions": [
        "edit"
      ],
      "recive_email": 1,
      "role": "admin",
      "status": "Active",
      "certificate": {
        "certificate_name": "MINHA EMPRESA",
        "issuer": "ICP-Brasil",
        "model": "Certificado PJ",
        "validity": "2025-10-04 11:51:00"
      }
    },
    "send_time": "04/06/2025 22:11:58",
    "update_time": "04/06/2025 22:12:00",
    "creted_at": "04/06/2025 22:11:58",
    "status": "Pending"
  },
  "message": "Sua solicitação foi enviada com sucesso!"
}