🚀 Comece aqui

Três passos para enviar o primeiro documento para assinatura.

  1. Pegue as credenciais. No painel Assin, em Desenvolvimento → API Keys, crie uma chave e copie publicKey e secretKey (aparece só na criação).
  2. Escolha como integrar (abaixo). Comece em Homologação: https://api.hml.assin.com.br.
  3. Siga um fluxo. O mais comum é Do PDF ao envelope enviado: enviar o PDF, definir quem assina e onde, lacrar e baixar o assinado.

🔑 Autenticação

Todas as rotas exigem um token JWT no header Authorization.

Toda requisição leva o header Authorization: Bearer <token>. O token é um JWT HS256 assinado com a sua secretKey, com este conteúdo:

{ "publicKey": "<sua publicKey>", "iat": 1760000000, "exp": 1760003600 }

As duas chaves estão no painel Assin, em Desenvolvimento → API Keys: publicKey e secretKey (a secretKey aparece só na criação da chave, guarde-a).

Por padrão, a API Key age em nome de quem a criou, então não é preciso informar o usuário no token. Para agir em nome de outro membro ativo da empresa (ex.: cada vendedor do seu sistema), envie "moreInfo": { "userId": "<User ID>" }: uma única chave atende vários usuários. Chaves criadas antes de outubro de 2026 não têm dono: nelas o userId é obrigatório.

Gere um token novo a cada requisição ou reutilize até o exp. Exemplos:

Node.js (npm i jsonwebtoken)

const jwt = require('jsonwebtoken');
const token = jwt.sign({ publicKey }, secretKey, { algorithm: 'HS256', expiresIn: '1h' });

Python (pip install pyjwt)

import jwt, time
now = int(time.time())
token = jwt.encode({"publicKey": public_key, "iat": now, "exp": now + 3600}, secret_key, algorithm="HS256")

PHP (composer require firebase/php-jwt)

use Firebase\JWT\JWT;
$token = JWT::encode(['publicKey' => $publicKey, 'iat' => time(), 'exp' => time() + 3600], $secretKey, 'HS256');

C# (System.IdentityModel.Tokens.Jwt)

var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secretKey));
var token = new JwtSecurityToken(
    claims: new[] { new Claim("publicKey", publicKey) },
    expires: DateTime.UtcNow.AddHours(1),
    signingCredentials: new SigningCredentials(key, SecurityAlgorithms.HmacSha256));
var jwt = new JwtSecurityTokenHandler().WriteToken(token);
ErroCausa
401 Not authorized for perform actionpublicKey inexistente ou token assinado com a secretKey errada
401 moreInfo.userId is required in the JWT payloadChave antiga, sem dono: envie o userId
403 moreInfo.userId is not an active member of the API key companyO usuário não é membro ativo da empresa
403 API key is disabledA chave foi desativada no painel

🌐 Base URL

Endereços da API por ambiente.

AmbienteURL
Produçãohttps://api.assin.com.br
Homologação (testes)https://api.hml.assin.com.br

Todas as rotas começam com /v1. Envie Content-Type: application/json nas requisições com corpo. Chamadas servidor a servidor não precisam do header Origin.

White label

A mesma base URL atende todas as marcas. A API Key define a empresa e a marca: envelopes, documentos e modelos ficam na sua conta, os links de assinatura saem no seu domínio (sign.seudominio.com.br) e e-mails e WhatsApp usam a sua identidade visual. Não envie Origin nem x-origin-with-label: o gateway define a marca pela chave. O que é criado pela API aparece no painel, e vice-versa.

📋 Headers Obrigatórios

Headers e formato dos corpos.

Presentes nas requisições à API:

HeaderExemploQuando
AuthorizationBearer eyJhbGciOiJIUzI1NiIs...Sempre. Token JWT (ver Autenticação)
Content-Typeapplication/jsonRequisições com corpo JSON
Idempotency-Key5f0c2b8e-6f4a-4a39-9d3e-2f7b9d1c8a10Opcional, nas rotas de criação, lacre e reenvio (ver Idempotência)
x-dynamic-authorizationtoken de documents-urlSó em GET /v1/documents/get-link-document

Chamadas servidor a servidor não precisam do header Origin.

Formato dos corpos

Arquivos (upload e download)

⚠️ Erros Padrão

Formato de resposta de erro padronizado em todos os endpoints.

StatusSignificado
400Dados inválidos ou regra de negócio violada. A mensagem diz o motivo
401Token ausente ou inválido
403Chave desativada, ou recurso de outra empresa
404Recurso não encontrado
409Mesma Idempotency-Key ainda em processamento
422Mesma Idempotency-Key usada com outro corpo ou rota
502Serviço interno indisponível; tente de novo
{
  "statusCode": 400,
  "error": "Some Envelope does not have a signer",
  "errorCode": "UNAUTHORIZED",
  "message": "Some Envelope does not have a signer",
  "rejectedInputs": [{ "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "reason": "Some Envelope does not have a signer", "errorCode": 2 }]
}

Erros de validação de campo listam cada problema em message (ex.: "data[0].email" is required).

🔁 Idempotência

Repita uma requisição com segurança, sem criar, lacrar ou cobrar duas vezes.

Rotas que criam algo, lacram ou reenviam aceitam o header Idempotency-Key (até 255 caracteres, recomendamos um UUID). Repetir a mesma operação com a mesma chave em até 24 horas devolve a primeira resposta, sem criar ou cobrar de novo (header Idempotent-Replayed: true). Use sempre ao lacrar envelopes e processar lotes.

🧭 Fluxos passo a passo

Escolha o que você quer fazer e siga os passos em ordem. Clique em um passo para ver os campos e exemplos.

📝

Envelope a partir de modelo

Contratos padronizados: a Assin preenche um modelo .docx e gera o PDF, sem upload.

Para contratos padronizados: a Assin gera o PDF preenchido e você segue o fluxo normal, sem upload. Precisa de um modelo cadastrado (no painel ou pela pasta Referência → Modelos).

  1. 1
    Escolher o modelo
    GET/templates
  2. 2
    Gerar documento preenchido
    POST/templates/generate-document
  3. 3
    Criar envelope
    POST/envelopes
  4. 4
    Vincular o documento gerado
    POST/envelopes/set/documents
  5. 5
    Adicionar signatários
    POST/envelope-signers
  6. 6
    Posicionar campos
    POST/tags
  7. 7
    Lacrar e enviardebita créditos
    PUT/envelopes/close
👥

Envelope com grupo de signatários

Mesmos signatários de sempre (diretoria, testemunhas) importados de uma vez.

Use um grupo salvo (ex.: diretoria) em vez de cadastrar signatários um a um. Requer um documento já criado (documentId, ver fluxo 01 passos 1 e 2).

  1. 1
    Criar grupo (uma vez)
    POST/signer-groups
  2. 2
    Criar envelope
    POST/envelopes
  3. 3
    Vincular documento
    POST/envelopes/set/documents
  4. 4
    Importar o grupo
    POST/signer-groups/import
  5. 5
    Conferir signatários
    GET/envelope-signers
  6. 6
    Posicionar campos
    POST/tags
  7. 7
    Lacrar e enviardebita créditos
    PUT/envelopes/close
⚡

Envio em massa (lote)

Um envelope por pessoa, com os mesmos documentos: centenas de envios numa chamada.

Um envelope por signatário variável, com os mesmos documentos e signatários fixos. Para adicionar mais signatários, repita o passo 4 trocando e-mail e nome (fixed: true para quem assina todos).

  1. 1
    Criar lote
    POST/batches
  2. 2
    Adicionar documento
    POST/batches-document
  3. 3
    Enviar o PDF
    PUT{uploadUrl}
  4. 4
    Adicionar signatário variável
    POST/batches-signer
  5. 5
    Adicionar signatário fixo (assina todos)
    POST/batches-signer
  6. 6
    Definir posições dos campos
    PUT/batches-document
  7. 7
    Processar lotedebita créditos
    POST/batches-envelopes/{companyId}/{batchId}
  8. 8
    Ver envelopes gerados
    GET/envelopes
🔔

Receber avisos (webhooks)

Seu sistema é avisado quando alguém assina, conclui, cancela ou expira.

Configure uma vez e receba avisos de assinatura, conclusão, cancelamento e expiração. Veja o formato do aviso na descrição da pasta Referência → Webhooks.

  1. 1
    Cadastrar webhook
    POST/webhook-domains
  2. 2
    Proteger com um header seu
    PUT/webhook-domains/{webhookId}/headers
  3. 3
    Conferir
    GET/webhook-domains
  4. •
    Se seu sistema ficou fora do ar: reenviar falhasopcional
    POST/webhook-domains/reprocess

📦 SDK Node.js

A forma mais rápida de integrar a partir de Node.js.

SDK oficial para Node.js 18+, tipado (TypeScript) e sem dependências. Por baixo ele usa esta mesma API, mas cuida do token, do upload dos PDFs, das retentativas seguras e do formato das requisições.

npm install @ostenverse/assin-api-node
import { Assin } from '@ostenverse/assin-api-node'
import { readFile } from 'node:fs/promises'

const assin = new Assin({
  publicKey: process.env.ASSIN_PUBLIC_KEY,
  secretKey: process.env.ASSIN_SECRET_KEY,
  environment: 'homologation',
})

const { envelope } = await assin.envelopes.send({
  title: 'Contrato de Prestação de Serviços',
  description: 'Contrato anual',
  documents: [{ name: 'Contrato.pdf', file: await readFile('./contrato.pdf') }],
  signers: [
    {
      fullName: 'Maria Souza',
      email: 'maria@exemplo.com.br',
      fields: [{ elementType: 'SIGNATURE', page: 1, axisX: 0.1, axisY: 0.8 }],
    },
  ],
})

const signed = await assin.envelopes.downloadSigned(envelope.id)
RecursoMétodos principais
assin.envelopessend, create, get, list, close, cancel, files, downloadSigned
assin.documentscreateFromFile, list, verify, delete
assin.signersadd, list, update, remove, resend, signingLinks
assin.fieldsadd, list, update, remove
assin.templateslist, create, generateDocument
assin.webhookscreate, setHeaders, reprocess, list, delete
assin.batchessend (lote inteiro numa chamada), create, addDocument, addSigner, setFields, process
assin.signerGroups, assin.folders, assin.contactsgestão

O send também aceita documento gerado de modelo ({ template: { id, name, values } }), grupos de signatários (signerGroups) e campos de qualquer signatário pelo e-mail (fields). Tipos de signatário, campos, canais, eventos e status são listas fechadas: o editor sugere os valores e acusa erro antes de rodar. Guia completo no README do pacote: npmjs.com/package/@ostenverse/assin-api-node.

🆕 Novidades v2.9.0

O que mudou nesta versão da API. Se você já integra, confira primeiro as mudanças que exigem ajuste.

Mudanças que exigem ajuste

RotaO que mudou
GET /v1/envelope-signersAgora lista os signatários de um envelope: envie ?envelopeId=. Antes listava os envelopes em que o usuário da chave assina
PUT /v1/envelopes/editNão aceita mais status. Use lacrar, bloquear ou cancelar
/v1/contactsRefeito: contatos da empresa, corpo { "data": { "name", "email", "phone" } }. PUT /v1/contacts/{id} removido
POST /v1/batches-template/update-templates-signer/... e GET /v1/batches-template/list-templates-signer/...Removidas (eram rotas do signatário e não funcionavam com API Key)
Rotas de loteO companyId precisa ser o da empresa da API Key (403 se for outro)
POST /v1/batches-signeremail obrigatório
POST /v1/envelope-signersSó com envelope em DRAFT ou BLOCK
Todas as respostas e webhooksCPF, data de nascimento, imagens de assinatura e rubrica e o token de acesso do signatário não são mais retornados (proteção de dados pessoais). Nome, e-mail, telefone e status continuam

Novidades

Correções

🔍 Sistema de Filtros

Filtros, ordenação, relacionamentos e paginação nas listagens.

Nas listagens que aceitam:

ParâmetroExemploObservação
filtersstatus:WAITING_SIGNATUREcampo:valor. Vários campos separados por ;, vários valores por ,
status:DRAFT,WAITING_SIGNATUREstatus DRAFT ou WAITING_SIGNATURE
title:contrato$%25iLike%25contém "contrato", sem diferenciar maiúsculas (%25 = %)
sortBycreatedAt:DESCASC ou DESC
includesenvelopeSigners,envelopeSigners.signerrelacionamentos, separados por vírgula
page1, 2, 3número da página, começando em 1 (padrão 1)
pageSize20máximo 100

Operadores depois de $: equals (padrão), not, iLike, %iLike%, iLike%, %iLike, isEmpty, isNotEmpty. Codifique % como %25 na URL.

🧪 Postman

Baixe a collection e siga os fluxos sem escrever código. O token é gerado automaticamente e os IDs passam de uma requisição para a outra.

Como usar

  1. No Postman, clique em Import e selecione os três arquivos.
  2. No canto superior direito, escolha o ambiente (comece por Homologação).
  3. Em Environments, preencha publicKey e secretKey (painel Assin → Desenvolvimento → API Keys). userId só em chaves antigas ou para agir em nome de outro membro.
  4. Rode 00 · Comece aqui. Resposta 200 = credenciais certas.
  5. Abra o fluxo desejado e rode as requisições em ordem. Nos passos de upload, selecione o arquivo em Body → binary.

A collection também funciona no Insomnia, Bruno e Hoppscotch (importação de collection Postman v2.1).

📄 Envelopes

O envelope agrupa documentos e signatários em um fluxo de assinatura. Ele nasce em DRAFT, recebe documentos, signatários e campos, e é lacrado para ser enviado. Depois de lacrado, só dá para gerenciar (reenviar, bloquear, cancelar).

Status do envelope

StatusSignificado
DRAFTRascunho: ainda pode receber documentos, signatários e campos
CREATEDLacrado, preparando o envio (dura segundos)
WAITING_SIGNATUREEnviado, aguardando assinaturas
BLOCKBloqueado: assinaturas pausadas
GET_LOCATIONS, GENERATE_FINGERPRINTS, GENERATE_BLOCKCHAIN, GENERATE_FINAL_DOC, GENERATE_ICP_BRASIL, FINISHING_DOCTodos assinaram, gerando o documento final
COMPLETEDConcluído: documento final disponível
CANCELEDCancelado
ERRORFalha no processamento (contate o suporte)

POST /envelopes Criar envelope Idempotency-Key ▼

Cria um ou mais envelopes em DRAFT. title precisa ser único dentro da requisição.

Parâmetros

CampoOndeTipoDescrição
data[].titlebodystringobrigatórioTítulo
data[].descriptionbodystringobrigatórioDescrição
data[].expiredAtbodyISO 8601opcionalPrazo para assinar. No mínimo amanhã
data[].notificationChannelbodyenumopcionalEMAIL (padrão) ou WHATSAPP. Com WhatsApp, todo signatário precisa de phone e há consumo de créditos de notificação
data[].validationByIcpbodybooleanopcionalAssinatura com certificado ICP-Brasil. Só se a empresa tiver ICP liberado
data[].folderIdbodyuuidopcionalPasta onde o envelope fica
data[].allowAutoResendbodybooleanopcionalReenviar o convite automaticamente a quem não assinou
data[].resendIntervalDaysbodystringopcionalIntervalo do reenvio automático, em dias (ex.: "3")

Erros comuns

  • 400 Company not authorized: validationByIcp sem ICP liberado
  • 400 data de expiração anterior a amanhã
Body
{
  "data": [
    {
      "title": "Contrato de Prestação de Serviços",
      "description": "Contrato anual com a empresa X",
      "expiredAt": "<expiredAt>",
      "notificationChannel": "EMAIL"
    }
  ]
}
Resposta 201
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Contrato de Prestação de Serviços",
      "description": "Contrato anual com a empresa X",
      "status": "DRAFT",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "expiredAt": "2026-10-28T12: 00: 00.000Z",
      "notificationChannel": "EMAIL",
      "validationByIcp": false,
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
POST /envelopes/set/documents Vincular documentos ao envelope Idempotency-Key ▼

Coloca documentos dentro do envelope. O envelope precisa estar em DRAFT (ou BLOCK). A ordem do array documents é a ordem no envelope.

Para desvincular, use a mesma rota com remove no lugar de set: POST /v1/envelopes/remove/documents.

Parâmetros

CampoOndeTipoDescrição
methodpathenumobrigatórioset (vincular) ou remove (desvincular)
data[].envelopeIdbodyuuidobrigatórioEnvelope
data[].documents[].idbodyuuidobrigatórioDocumento

Erros comuns

  • 400 Document already in envelope
  • 400 envelope fora de DRAFT/BLOCK
Body
{
  "data": [
    {
      "envelopeId": "<envelopeId>",
      "documents": [
        {
          "id": "<documentId>"
        }
      ]
    }
  ]
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "originalDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "order": 1
    }
  ]
}
PUT /envelopes/documents-order Reordenar documentos ▼

Define a nova ordem dos documentos. documentIds deve conter todos os documentos do envelope, sem repetir. Envelope em DRAFT.

Parâmetros

CampoOndeTipoDescrição
data[].envelopeIdbodyuuidobrigatórioEnvelope
data[].documentIdsbodyuuid[]obrigatórioIDs na nova ordem
Body
{
  "data": [
    {
      "envelopeId": "<envelopeId>",
      "documentIds": [
        "<documentId>"
      ]
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "originalDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "order": 1
    }
  ]
}
PUT /envelopes/close Lacrar e enviar para assinatura Idempotency-Key ▼

Lacra o envelope, debita os créditos e dispara os convites aos signatários. Use sempre Idempotency-Key: se houver timeout e você repetir com a mesma chave, não há cobrança dupla.

Requisitos: envelope em DRAFT (ou BLOCK), ao menos 1 documento e 1 signatário, créditos suficientes. Com canal WhatsApp, todo signatário precisa de telefone válido.

A resposta traz o status CREATED; em segundos ele passa a WAITING_SIGNATURE.

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioEnvelope

Erros comuns

  • 400 Some Envelope not found in database: id inexistente ou de outra empresa
  • 400 Some Envelopes does not have a draft status
  • 400 Some Envelope does not have a document
  • 400 Some Envelope does not have a signer
  • 400 Company does not have enough credit
  • 400 Invalid phone number: canal WhatsApp com signatário sem telefone E.164
Body
{
  "data": [
    {
      "id": "<envelopeId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "CREATED"
    }
  ]
}
GET /envelopes Listar e consultar envelopes ▼

Lista os envelopes da empresa com filtros, ordenação, paginação e relacionamentos (ver Filtros e paginação).

  • Campos filtráveis: id, title, description, status, expiredAt, createdAt, updatedAt.
  • includes: envelopeSigners, envelopeSigners.signer, envelopeDocuments, envelopeDocuments.originalDocument, envelopeDocuments.tags, user.

Consultar um envelope com tudo: filters=id:<envelopeId>&includes=envelopeSigners,envelopeSigners.signer,envelopeDocuments.

Resposta 200
{
  "currentPage": 1,
  "pageSize": 20,
  "totalPages": 1,
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Contrato",
      "status": "WAITING_SIGNATURE",
      "expiredAt": "2026-10-28T12: 00: 00.000Z",
      "createdAt": "2026-10-13T12: 00: 00.000Z",
      "envelopeSigners": [
        {
          "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "order": 0,
          "signatureType": "PARTY",
          "status": "PENDING",
          "signer": {
            "fullName": "Maria Souza",
            "email": "maria@exemplo.com.br"
          }
        }
      ]
    }
  ]
}
GET /envelopes/{envelopeId}/documents Baixar documentos do envelope (inclui o PDF assinado) ▼

Devolve links de download (válidos por 5 minutos) de cada documento do envelope:

  • original: o PDF enviado.
  • signed: o PDF final assinado, com a página de evidências. Só existe quando o envelope está COMPLETED. type é ICP quando houve assinatura ICP-Brasil, senão SUMMARY.

Chame de novo quando precisar de um link novo.

Parâmetros

CampoOndeTipoDescrição
envelopeIdpathuuidobrigatórioEnvelope

Erros comuns

  • 404 Envelope not found
Resposta 200
{
  "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "COMPLETED",
  "expiresIn": 300,
  "documents": [
    {
      "order": 1,
      "original": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "alias": "Contrato.pdf",
        "url": "https://...presigned..."
      },
      "signed": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "alias": "Contrato.pdf",
        "url": "https://...presigned...",
        "type": "SUMMARY"
      }
    }
  ]
}
PUT /envelopes/edit Editar envelope ▼

Altera título, descrição, prazo ou ICP. Permitido antes de qualquer assinatura. validationByIcp só pode mudar em DRAFT/BLOCK e exige ICP liberado na empresa. O status não pode ser alterado por aqui.

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioEnvelope
data[].titlebodystringopcional
data[].descriptionbodystringopcional
data[].expiredAtbodyISO 8601opcional
data[].validationByIcpbodybooleanopcional

Erros comuns

  • 400 Envelope status cannot be changed through edit
  • 400 This company does not have permission to use the ICP
Body
{
  "data": [
    {
      "id": "<envelopeId>",
      "title": "Contrato de Prestação de Serviços (rev. 2)"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Contrato de Prestação de Serviços (rev. 2)"
    }
  ]
}
PUT /envelopes/block-envelope Bloquear / desbloquear ▼

Alterna o estado: WAITING_SIGNATURE → BLOCK (pausa as assinaturas) e BLOCK → WAITING_SIGNATURE. Não funciona se algum signatário já concluiu (inclusive CARBON_COPY, que conclui ao lacrar).

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioEnvelope
Body
{
  "data": [
    {
      "id": "<envelopeId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "BLOCK"
    }
  ]
}
PUT /envelopes/cancel Cancelar envelope ▼

Cancela o envelope (CANCELED). Os links de assinatura deixam de funcionar e o webhook ENVELOPE_CANCELLED é disparado. Não pode ser desfeito.

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioEnvelope
Body
{
  "data": [
    {
      "id": "<envelopeId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "CANCELED"
    }
  ]
}
DELETE /envelopes/{envelopeId} Excluir rascunho ▼

Exclui um envelope em DRAFT. Para envelopes já enviados, use cancelar.

Parâmetros

CampoOndeTipoDescrição
envelopeIdpathuuidobrigatórioEnvelope

Erros comuns

  • 400 Status of envelope is not DRAFT
Resposta 200
{
  "totalElements": 1,
  "envelopes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
GET /envelopes/stats-created Resumo de envelopes ▼

Totais de envelopes da empresa.

Resposta 200
{
  "allEnvelopes": 120,
  "processing": 14,
  "rejected": 3,
  "finished": 103
}

🗂 Documents

Um documento é um PDF da sua empresa. O envio do arquivo é feito em duas etapas: primeiro você cria o registro (recebe uma URL de upload), depois envia os bytes do PDF direto para essa URL. Em seguida o documento pode ser vinculado a um ou mais envelopes.


POST /documents Criar documento (gera URL de upload) Idempotency-Key ▼

Cria o registro do documento e devolve, em url, uma URL de upload válida por 5 minutos. O PDF ainda não foi enviado: faça o PUT do arquivo nessa URL (próxima rota).

Envie vários documentos de uma vez colocando mais itens em data. alias precisa ser único dentro da requisição.

Parâmetros

CampoOndeTipoDescrição
data[].aliasbodystringobrigatórioNome do documento (ex.: Contrato.pdf)
Body
{
  "data": [
    {
      "alias": "Contrato de Prestação de Serviços.pdf"
    }
  ]
}
Resposta 201
{
  "totalElements": 1,
  "documents": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Contrato de Prestação de Serviços.pdf",
      "url": "https://<bucket>.s3.amazonaws.com/companies/.../originalDocument.pdf?X-Amz-Expires=300&...",
      "createdFrom": "API",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
PUT {uploadUrl} Enviar o PDF para a URL de upload sem Authorization ▼

Envia os bytes do PDF para a url recebida na criação do documento.

  • Corpo: o arquivo PDF puro (binário). Não é multipart nem JSON.
  • Sem header Authorization: esta requisição vai direto ao storage, não à API.
  • Header Content-Type: application/pdf.
  • Faça em até 5 minutos. Se expirar, crie o documento de novo.

No Postman: aba Body → binary e selecione o PDF.

curl -X PUT "$UPLOAD_URL" -H "Content-Type: application/pdf" --data-binary @contrato.pdf
Resposta
200 com corpo vazio.
GET /documents Listar documentos ▼

Lista os documentos da empresa. Aceita filters, sortBy, page e pageSize (ver Filtros e paginação). Campos filtráveis: id, alias, createdFrom, createdAt. O url de cada item é um link de download válido por 5 minutos.

Resposta 200
{
  "currentPage": 1,
  "pageSize": 20,
  "totalPages": 1,
  "totalElements": 1,
  "documents": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Contrato.pdf",
      "url": "https://...presigned...",
      "createdFrom": "API",
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
DELETE /documents/{documentId}/delete Excluir documento ▼

Exclui o documento e o arquivo. Só é permitido se o documento não estiver em nenhum envelope ou se os envelopes em que ele está ainda forem DRAFT. Documentos finais (assinados) não podem ser excluídos.

Parâmetros

CampoOndeTipoDescrição
documentIdpathuuidobrigatórioID do documento
Resposta
204 sem corpo
GET /documents/verify-document Verificar autenticidade de um documento ▼

Consulta a situação de um documento. Informe um dos parâmetros:

  • fingerprint: o hash impresso no documento final. Resposta Document is valid se for autêntico.
  • documentId: o ID do documento original. A resposta diz em que fase ele está.

Mensagens possíveis: Document is valid, Document waiting signatures, Document was signed on DD/MM/YYYY at HH:mm., Document has been canceled, Document in generating process, Document in process to be signed, There was an error, No info about the document.

Parâmetros

CampoOndeTipoDescrição
fingerprintquerystringopcionalHash do documento final
documentIdqueryuuidopcionalID do documento original

Erros comuns

  • 400 se nenhum parâmetro for enviado ou o documento não for encontrado
Resposta 200
{
  "message": "Document was signed on 13/10/2026 at 15: 42."
}
POST /envelopes/documents-url Gerar token de visualização de documentos ▼

Gera um token (válido por 5 minutos) que libera o download dos documentos informados em GET /v1/documents/get-link-document. Para baixar documentos de um envelope, prefira GET /v1/envelopes/{envelopeId}/documents, que é mais simples e inclui o PDF assinado.

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioID do documento
Body
{
  "data": [
    {
      "id": "<documentId>"
    }
  ]
}
Resposta 201
{
  "token": "eyJhbGciOiJIUzI1NiIs..."
}

📝 Templates

Modelos são arquivos .docx com campos no formato {{nomeDoCampo}}. A Assin preenche os campos e gera um PDF, que vira um documento normal para usar em envelopes.


GET /templates Listar modelos ▼

Lista os modelos ativos e inativos. keys são os campos que precisam ser preenchidos. Aceita filters, sortBy, page, pageSize.

Resposta 200
{
  "totalElements": 1,
  "templates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Contrato CLT",
      "description": "Modelo padrão",
      "isActive": true,
      "file": "https://...presigned .docx...",
      "keys": [
        {
          "alias": "nomeColaborador",
          "description": "Nome",
          "maxSize": 100
        }
      ]
    }
  ]
}
POST /templates Criar modelo (gera URL de upload do .docx) Idempotency-Key ▼

Cria o modelo e devolve em file uma URL de upload válida por 5 minutos para o .docx. Envie o arquivo com PUT nessa URL, corpo binário e header Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document.

Cada item de keys descreve um campo {{alias}} existente no .docx.

Parâmetros

CampoOndeTipoDescrição
data[].aliasbodystringobrigatórioNome do modelo
data[].descriptionbodystringobrigatório
data[].keys[].aliasbodystringobrigatórioNome do campo no .docx, sem as chaves
data[].keys[].descriptionbodystringobrigatórioDescrição do campo
data[].keys[].maxSizebodyintegerobrigatórioTamanho máximo do valor
Body
{
  "data": [
    {
      "alias": "Contrato CLT",
      "description": "Modelo padrão de contratação",
      "keys": [
        {
          "alias": "nomeColaborador",
          "description": "Nome completo",
          "maxSize": 120
        },
        {
          "alias": "cpf",
          "description": "CPF",
          "maxSize": 14
        }
      ]
    }
  ]
}
Resposta 201
{
  "totalElements": 1,
  "templates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Contrato CLT",
      "isActive": true,
      "file": "https://<bucket>.s3.amazonaws.com/...docx?X-Amz-Expires=300&..."
    }
  ]
}
PUT {templateUploadUrl} Enviar o .docx do modelo sem Authorization ▼

Envia o arquivo .docx para a URL recebida na criação do modelo. Corpo binário, sem Authorization.

Resposta
200 com corpo vazio.
POST /templates/generate-document Gerar documento a partir do modelo Idempotency-Key ▼

Preenche o modelo e gera um PDF. O id devolvido é um documento comum: vincule-o a um envelope com POST /v1/envelopes/set/documents.

key deve ser igual ao alias do campo no modelo. Valores maiores que maxSize ou campos inexistentes voltam em rejectedInputs.

Parâmetros

CampoOndeTipoDescrição
data[].templateIdbodyuuidobrigatórioModelo
data[].documents[].aliasbodystringobrigatórioNome do documento gerado
data[].documents[].keys[].keybodystringobrigatórioCampo
data[].documents[].keys[].descriptionbodystringobrigatório
data[].documents[].keys[].valuebodystringobrigatórioValor
Body
{
  "data": [
    {
      "templateId": "<templateId>",
      "documents": [
        {
          "alias": "Contrato - João Silva",
          "keys": [
            {
              "key": "nomeColaborador",
              "description": "Nome completo",
              "value": "João Silva"
            },
            {
              "key": "cpf",
              "description": "CPF",
              "value": "123.456.789-00"
            }
          ]
        }
      ]
    }
  ]
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Contrato - João Silva",
      "url": "https://...presigned...",
      "createdFrom": "GENERATE_BY_ASSIN"
    }
  ]
}
PUT /templates/activate/true Ativar / desativar modelo ▼

true no fim da URL ativa, false desativa.

Parâmetros

CampoOndeTipoDescrição
statuspathbooleanobrigatóriotrue ou false
data[].idbodyuuidobrigatórioModelo
Body
{
  "data": [
    {
      "id": "<templateId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "templates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": true
    }
  ]
}
DELETE /templates/delete Excluir modelo ▼

Exclui um modelo criado pelo usuário da API Key.

Parâmetros

CampoOndeTipoDescrição
data[].idbodyuuidobrigatórioModelo
Body
{
  "data": [
    {
      "id": "<templateId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "templates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

✍️ Envelope Signers

Quem assina (ou aprova, testemunha, recebe cópia). Nas rotas de signatários o envelopeId fica fora do data. O identificador de cada signatário no envelope é o signerId: ele é usado nos campos de assinatura, no reenvio e no link de assinatura.

Ordem: order: 0 em todos = todos assinam ao mesmo tempo. order: 1, 2, 3... = cada um recebe o convite depois que o anterior assina. Não misture 0 com valores maiores.

Status do signatário

PENDING aguardando · SIGNED / COMPLETED assinou · REJECTED recusou.


POST /envelope-signers Adicionar signatários Idempotency-Key ▼

Adiciona signatários ao envelope. Envelope em DRAFT ou BLOCK. email precisa ser único no envelope.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].fullNamebodystringobrigatórioNome completo
data[].emailbodystringobrigatórioE-mail
data[].orderbodyintegerobrigatório0 = paralelo; 1, 2, 3... = sequencial
data[].signatureTypebodyenumobrigatórioPARTY (parte), WITNESS (testemunha), APPROVER (aprovador), CLIENT, SELLER, MANAGER, ACKNOWLEDGE (ciência), ACKNOWLEDGE_RECEIPT (ciência de recebimento), CARBON_COPY (só recebe cópia, não assina)
data[].requirePersonalDocumentbodybooleanobrigatórioPede foto de documento + selfie (validação biométrica)
data[].requireEmailTokenbodybooleanobrigatórioPede código enviado por e-mail antes de assinar
data[].phonebodystringopcionalFormato E.164: +5511999999999. Obrigatório com canal WhatsApp

Erros comuns

  • 400 Signers can only be added while the envelope is in DRAFT or BLOCK
  • 400 e-mail repetido no envelope
  • 400 Order must be zero (0) / Order must be greater than zero (0): mistura de order 0 com maior que 0, inclusive com os signatários já existentes
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "fullName": "Maria Souza",
      "email": "maria@exemplo.com.br",
      "phone": "+5511999999999",
      "order": 0,
      "signatureType": "PARTY",
      "requirePersonalDocument": false,
      "requireEmailToken": false
    },
    {
      "fullName": "João Lima",
      "email": "joao@exemplo.com.br",
      "order": 0,
      "signatureType": "WITNESS",
      "requirePersonalDocument": false,
      "requireEmailToken": false
    }
  ]
}
Resposta 201
{
  "totalElements": 2,
  "envelopeSigners": [
    {
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "order": 0,
      "signatureType": "PARTY",
      "status": "PENDING",
      "requirePersonalDocument": false,
      "requireEmailToken": false,
      "signer": {
        "fullName": "Maria Souza",
        "email": "maria@exemplo.com.br"
      }
    }
  ]
}
GET /envelope-signers Listar signatários do envelope ▼

Lista os signatários de um envelope, na ordem de assinatura, com o status de cada um.

Parâmetros

CampoOndeTipoDescrição
envelopeIdqueryuuidobrigatórioEnvelope

Erros comuns

  • 400 Envelope not found
Resposta 200
{
  "totalElements": 2,
  "envelopeSigners": [
    {
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "order": 0,
      "signatureType": "PARTY",
      "status": "COMPLETED",
      "requirePersonalDocument": false,
      "requireEmailToken": false,
      "createdAt": "2026-10-13T12: 00: 00.000Z",
      "updatedAt": "2026-10-13T15: 42: 00.000Z",
      "signer": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "fullName": "Maria Souza",
        "email": "maria@exemplo.com.br",
        "phone": "+5511999999999"
      }
    }
  ]
}
PUT /envelope-signers Corrigir dados do signatário ▼

Corrige nome, e-mail ou telefone de quem ainda não assinou (envelope em DRAFT ou WAITING_SIGNATURE). Se o e-mail mudar com o envelope já enviado, a Assin reenvia o convite para o novo endereço e passa a exigir código por e-mail. Se a pessoa já assinou outros envelopes, nome e e-mail ficam travados (a identidade dela é a mesma em todos): remova o signatário e adicione outro.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].signerIdbodyuuidobrigatórioSignatário
data[].fullNamebodystringopcional
data[].emailbodystringopcional
data[].phonebodystringopcionalE.164
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "signerId": "<signerId>",
      "email": "maria.souza@exemplo.com.br"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopeSigners": [
    {
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "PENDING"
    }
  ]
}
DELETE /envelope-signers Remover signatário ▼

Remove signatários que ainda não assinaram. Envelope em DRAFT, BLOCK, CREATED ou WAITING_SIGNATURE.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].signerIdbodyuuidobrigatórioSignatário

Erros comuns

  • 400 Envelope signer has already signed and cannot be removed
  • 400 Signers cannot be removed from an envelope with this status
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "signerId": "<signer2Id>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "envelopeSigners": [
    {
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
POST /envelope-signers/resend-notification/EMAIL Reenviar convite Idempotency-Key ▼

Reenvia o convite de assinatura. Canal no fim da URL: EMAIL, WHATSAPP ou SMS.

Só para signatários PENDING, com envelope em WAITING_SIGNATURE. Intervalo mínimo de 1 minuto entre envios para o mesmo signatário, contando também o convite enviado ao lacrar. Para SMS/WhatsApp, o signatário precisa ter telefone (ou informe number).

Parâmetros

CampoOndeTipoDescrição
typepathenumobrigatórioEMAIL, WHATSAPP ou SMS
envelopeIdbodyuuidobrigatórioEnvelope
data[].signerIdbodyuuidobrigatórioSignatário
data[].numberbodystringopcionalTelefone E.164 para SMS/WhatsApp
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "signerId": "<signerId>"
    }
  ]
}
Resposta
201 com corpo vazio.
GET /envelope-signers/stats-signer Resumo dos envelopes em que o usuário da chave assina ▼

Totais de envelopes em que o usuário dono da API Key é signatário.

Resposta 200
{
  "allEnvelopes": 8,
  "processing": 2,
  "rejected": 0,
  "finished": 6
}

🏷 Tags

Definem onde cada signatário assina, rubrica ou tem o nome impresso no PDF. São opcionais: sem campos, o signatário assina e a assinatura vai para a página de evidências.

Coordenadas

  • axisX e axisY são frações da página, de 0 a 1, medidas a partir do canto superior esquerdo. O ponto marca o canto superior esquerdo do campo.
  • axisX: 0.10 = 10% da largura a partir da esquerda; axisY: 0.80 = 80% da altura a partir do topo.
  • width e height também são frações (0.01 a 1). Padrão: 0.15 × 0.07.
  • page começa em 1.

Exemplo: para um PDF A4 (595 × 842 pt), um campo em x=60pt, y=670pt (do topo) é axisX = 60/595 ≈ 0.10, axisY = 670/842 ≈ 0.80.


POST /tags Posicionar campos Idempotency-Key ▼

Cria campos no documento. Envelope em DRAFT ou BLOCK.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].envelopeSignerIdbodyuuidobrigatórioO signerId do signatário. Não usado em TEXT_BOX
data[].envelopeDocumentIdbodyuuidobrigatórioO id do documento
data[].elementTypebodyenumobrigatórioSIGNATURE (assinatura), RUBRIC (rubrica), FULL_NAME (nome), EMAIL, SIGNATURE_DATETIME (data/hora da assinatura), SELECTION_BOX (caixa de seleção), TEXT_BOX (texto livre, sem signatário)
data[].pagebodyintegerobrigatórioPágina (a partir de 1)
data[].axisXbodynumberobrigatório0 a 1, da esquerda
data[].axisYbodynumberobrigatório0 a 1, do topo
data[].widthbodynumberopcional0.01 a 1
data[].heightbodynumberopcional0.01 a 1
data[].contentbodystringopcionalTexto (para TEXT_BOX)
data[].fontFamilybodyenumopcionalHelvetica, Helvetica-Bold, Times-Roman, Courier e variações
data[].fontSizebodyintegeropcional6 a 96
data[].fontColorbodystringopcional#RRGGBB
data[].anglebodynumberopcionalPadrão 0
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "envelopeSignerId": "<signerId>",
      "envelopeDocumentId": "<documentId>",
      "elementType": "SIGNATURE",
      "page": 1,
      "axisX": 0.1,
      "axisY": 0.8
    },
    {
      "envelopeSignerId": "<signerId>",
      "envelopeDocumentId": "<documentId>",
      "elementType": "FULL_NAME",
      "page": 1,
      "axisX": 0.1,
      "axisY": 0.88
    },
    {
      "envelopeSignerId": "<signer2Id>",
      "envelopeDocumentId": "<documentId>",
      "elementType": "SIGNATURE",
      "page": 1,
      "axisX": 0.55,
      "axisY": 0.8
    }
  ]
}
Resposta 201
{
  "totalElements": 3,
  "tags": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeSignerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "elementType": "SIGNATURE",
      "page": 1,
      "axisX": 0.1,
      "axisY": 0.8,
      "width": 0.15,
      "height": 0.07,
      "angle": 0
    }
  ]
}
GET /tags Listar campos ▼

Lista os campos de um envelope. envelopeId é obrigatório no filtro; envelopeDocumentId é opcional.

Parâmetros

CampoOndeTipoDescrição
filtersquerystringobrigatórioenvelopeId:<uuid> e opcionalmente ;envelopeDocumentId:<uuid>
Resposta 200
{
  "totalElements": 1,
  "tags": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeSignerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "envelopeDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "elementType": "SIGNATURE",
      "page": 1,
      "axisX": 0.1,
      "axisY": 0.8,
      "width": 0.15,
      "height": 0.07
    }
  ]
}
PUT /tags Mover / ajustar campo ▼

Altera posição, página, tamanho, texto ou fonte. Não muda o tipo nem o signatário (para isso, remova e crie de novo). Envelope em DRAFT ou BLOCK.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].idbodyuuidobrigatórioCampo
data[].page / axisX / axisY / width / height / content / fontFamily / fontSize / fontColor / anglebodyopcionalMesmas regras da criação
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "id": "<tagId>",
      "page": 1,
      "axisX": 0.12,
      "axisY": 0.75
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "tags": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "axisX": 0.12,
      "axisY": 0.75
    }
  ]
}
DELETE /tags Remover campo ▼

Envelope em DRAFT ou BLOCK.

Parâmetros

CampoOndeTipoDescrição
envelopeIdbodyuuidobrigatórioEnvelope
data[].idbodyuuidobrigatórioCampo
Body
{
  "envelopeId": "<envelopeId>",
  "data": [
    {
      "id": "<tagId>"
    }
  ]
}
Resposta 200
{
  "totalElements": 1,
  "tags": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

👥 Signer Groups

Listas de signatários que se repetem (ex.: diretoria, testemunhas fixas). Em vez de adicionar um a um, importe o grupo inteiro para o envelope. Nestas rotas data é um objeto.


POST /signer-groups Criar grupo Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
data.namebodystringobrigatório1 a 100 caracteres
data.members[].fullNamebodystringobrigatório
data.members[].emailbodystringobrigatório
data.members[].signatureTypebodyenumobrigatórioMesmos tipos de signatário
data.members[].orderbodyintegerobrigatório0 = paralelo
Body
{
  "data": {
    "name": "Diretoria",
    "members": [
      {
        "fullName": "Carlos Mendes",
        "email": "carlos@exemplo.com.br",
        "signatureType": "PARTY",
        "order": 0
      },
      {
        "fullName": "Ana Prado",
        "email": "ana@exemplo.com.br",
        "signatureType": "APPROVER",
        "order": 0
      }
    ]
  }
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Diretoria",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "members": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fullName": "Carlos Mendes",
          "email": "carlos@exemplo.com.br",
          "signatureType": "PARTY",
          "order": 0
        }
      ]
    }
  ]
}
GET /signer-groups Listar grupos ▼

Lista os grupos da empresa com seus membros.

Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Diretoria",
      "members": [
        {
          "fullName": "Carlos Mendes",
          "email": "carlos@exemplo.com.br",
          "signatureType": "PARTY",
          "order": 0
        }
      ]
    }
  ]
}
POST /signer-groups/import Importar grupo para um envelope Idempotency-Key ▼

Adiciona os membros do grupo como signatários do envelope (DRAFT). Quem já está no envelope é ignorado.

Parâmetros

CampoOndeTipoDescrição
data.groupIdbodyuuidobrigatórioGrupo
data.envelopeIdbodyuuidobrigatórioEnvelope

Erros comuns

  • 400 Envelope must be in DRAFT status
  • 400 No new signers to import
  • 404 grupo ou envelope não encontrado
Body
{
  "data": {
    "groupId": "<groupId>",
    "envelopeId": "<envelopeId>"
  }
}
Resposta 201
{
  "totalElements": 2,
  "entities": [
    {
      "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "PARTY",
      "order": 0,
      "status": "PENDING"
    }
  ]
}
PUT /signer-groups/{groupId} Atualizar grupo ▼

Substitui nome e membros (envie a lista completa). Só quem criou o grupo pode alterar.

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioGrupo
data.namebodystringobrigatório
data.membersbodyarrayobrigatórioLista completa
Body
{
  "data": {
    "name": "Diretoria 2026",
    "members": [
      {
        "fullName": "Carlos Mendes",
        "email": "carlos@exemplo.com.br",
        "signatureType": "PARTY",
        "order": 0
      }
    ]
  }
}
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Diretoria 2026"
    }
  ]
}
DELETE /signer-groups/{groupId} Excluir grupo ▼

Só quem criou o grupo pode excluir.

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioGrupo
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

📁 Folders

Organizam os envelopes do usuário da API Key dentro da empresa. Pastas podem ter subpastas (parentId). Para criar um envelope já dentro de uma pasta, envie folderId na criação do envelope. Nestas rotas data é um objeto.


POST /folders Criar pasta Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
data.namebodystringobrigatório1 a 100 caracteres
data.parentIdbodyuuid | nullopcionalPasta-mãe
Body
{
  "data": {
    "name": "Contratos 2026"
  }
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Contratos 2026",
      "parentId": null,
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
GET /folders Listar pastas (árvore) ▼

Retorna a árvore de pastas; subpastas vêm em children.

Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Contratos 2026",
      "parentId": null,
      "children": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "Fornecedores",
          "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "children": []
        }
      ]
    }
  ]
}
PUT /folders/{folderId} Renomear / mover pasta ▼

Envie name e/ou parentId. Sem parentId, a pasta fica onde está; parentId: null move para a raiz.

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioPasta
data.namebodystringopcional
data.parentIdbodyuuid | nullopcional

Erros comuns

  • 404 Folder not found
  • 400 mover para ela mesma ou para uma subpasta
Body
{
  "data": {
    "name": "Contratos 2026 - Assinados"
  }
}
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Contratos 2026 - Assinados"
    }
  ]
}
DELETE /folders/{folderId} Excluir pasta ▼

As subpastas sobem para a pasta-mãe.

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioPasta
Resposta 200
{
  "totalElements": 0,
  "entities": []
}

📬 Contacts

Agenda de contatos da empresa, usada para preencher signatários. Criar e excluir exige que o usuário da API Key seja gestor da empresa.


POST /contacts Criar contato Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
data.namebodystringobrigatório1 a 150
data.emailbodystringobrigatório
data.phonebodystringopcional

Erros comuns

  • 400 This contact exist
Body
{
  "data": {
    "name": "Maria Souza",
    "email": "maria@exemplo.com.br",
    "phone": "+5511999999999"
  }
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
GET /contacts Listar / buscar contatos ▼

search busca por nome, e-mail ou telefone (com search, a paginação é ignorada e voltam até pageSize resultados).

Parâmetros

CampoOndeTipoDescrição
pagequeryintegeropcionalNúmero da página, a partir de 1 (padrão 1)
pageSizequeryintegeropcional1 a 100 (padrão 20)
searchquerystringopcionalBusca
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Maria Souza",
      "email": "maria@exemplo.com.br",
      "phone": "+5511999999999",
      "envelopeSigners": 4,
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
DELETE /contacts/{contactId} Excluir contato ▼

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioContato

Erros comuns

  • 404 Contact not found
Resposta
204 sem corpo

🔔 Webhook Domains

Cadastre uma URL e a Assin avisa seu sistema quando algo acontece, sem você precisar consultar. Nestas rotas data é um objeto.

Eventos

EventoQuando
SIGNER_COMPLETEDUm signatário concluiu (não dispara para CARBON_COPY)
ENVELOPE_FINISHEDTodos assinaram e o PDF final está pronto. Baixe com GET /v1/envelopes/{id}/documents
ENVELOPE_CANCELLEDO envelope foi cancelado
ENVELOPE_EXPIREDO prazo venceu sem todas as assinaturas (verificação diária, por volta das 09:00 de Brasília)

Como o aviso chega

  • POST na sua URL, Content-Type: application/json, timeout de 10 segundos. Responda 2xx rapidamente e processe depois.
  • Header x-assin-event-id: identificador único do evento (o mesmo do campo eventId). Use para ignorar duplicados.
  • Os headers que você cadastrou (ex.: Authorization), para validar que o aviso veio da Assin.
  • Não há nova tentativa automática. Se seu endpoint falhar, use POST /v1/webhook-domains/reprocess.

Corpo (exemplo SIGNER_COMPLETED, resumido)

{
  "event": "SIGNER_COMPLETED",
  "eventId": "6f1c2a4e-8b0d-5c3a-9e7f-1a2b3c4d5e6f",
  "envelope": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Contrato de Prestação de Serviços",
    "status": "WAITING_SIGNATURE",
    "expiredAt": "2026-10-28T12:00:00.000Z",
    "conclusionDate": null,
    "validationByIcp": false,
    "notificationChannel": "EMAIL",
    "envelopeSigners": [
      {
        "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "order": 0,
        "signatureType": "PARTY",
        "status": "COMPLETED",
        "signer": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fullName": "Maria Souza",
          "email": "maria@exemplo.com.br"
        }
      }
    ]
  },
  "signer": {
    "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "envelopeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "COMPLETED",
    "signatureType": "PARTY",
    "signer": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fullName": "Maria Souza",
      "email": "maria@exemplo.com.br"
    }
  }
}

Os outros eventos têm o mesmo formato, sem o campo signer. envelope traz o envelope completo com todos os signatários.


POST /webhook-domains Cadastrar webhook Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
data.domainbodyURLobrigatórioEndereço que recebe os avisos (http ou https)
data.eventsbodyenum[]obrigatórioUm ou mais eventos
data.descriptionbodystringopcionalAté 255 caracteres
Body
{
  "data": {
    "domain": "https://seusistema.com.br/webhooks/assin",
    "description": "Produção",
    "events": [
      "SIGNER_COMPLETED",
      "ENVELOPE_FINISHED",
      "ENVELOPE_CANCELLED",
      "ENVELOPE_EXPIRED"
    ]
  }
}
Resposta 201
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "domain": "https://seusistema.com.br/webhooks/assin",
  "description": "Produção",
  "isActive": true,
  "headers": {},
  "eventSubscriptions": [
    {
      "eventType": "SIGNER_COMPLETED"
    },
    {
      "eventType": "ENVELOPE_FINISHED"
    }
  ]
}
PUT /webhook-domains/{webhookId}/headers Definir headers enviados nos avisos ▼

Adiciona ou substitui headers enviados em todos os avisos (ex.: um segredo para você validar). Até 20 headers; nomes são gravados em minúsculas; valores aparecem mascarados nas respostas. Não é permitido Content-Type, Content-Length, Host, Transfer-Encoding e Connection.

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioWebhook
data.headersbodyobjetoobrigatório{ "Nome": "valor" }
Body
{
  "data": {
    "headers": {
      "Authorization": "Bearer seu-segredo-aqui"
    }
  }
}
Resposta 200
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "headers": {
    "authorization": "Bear…"
  }
}
DELETE /webhook-domains/{webhookId}/headers Remover headers ▼

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioWebhook
data.namesbodystring[]obrigatórioNomes dos headers
Body
{
  "data": {
    "names": [
      "authorization"
    ]
  }
}
Resposta 200
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "headers": {}
}
GET /webhook-domains Listar webhooks ▼
Resposta 200
{
  "totalElements": 1,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "domain": "https://seusistema.com.br/webhooks/assin",
      "isActive": true,
      "headers": {
        "authorization": "Bear…"
      },
      "eventSubscriptions": [
        {
          "eventType": "ENVELOPE_FINISHED"
        }
      ]
    }
  ]
}
PUT /webhook-domains/{webhookId} Alterar / desativar webhook ▼

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioWebhook
data.domainbodyURLopcional
data.eventsbodyenum[]opcional
data.descriptionbodystringopcional
data.isActivebodybooleanopcionalfalse para pausar os avisos

Erros comuns

  • 404 webhook não encontrado
Body
{
  "data": {
    "isActive": false
  }
}
Resposta 200
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false
}
POST /webhook-domains/reprocess Reenviar avisos que falharam Idempotency-Key ▼

Reenvia os avisos (a última tentativa de cada envelope e evento) para os webhooks ativos. Até 500 por chamada.

Parâmetros

CampoOndeTipoDescrição
data.onlyFailedbodybooleanopcionalSó os que não receberam 2xx (padrão true)
data.envelopeIdsbodyuuid[]opcionalLimitar a envelopes (até 500)
data.frombodyISO 8601opcionalInício do período
data.tobodyISO 8601opcionalFim do período
Body
{
  "data": {
    "onlyFailed": true
  }
}
Resposta 200
{
  "matched": 3,
  "resent": 3,
  "succeeded": 3,
  "failed": 0,
  "skipped": 0,
  "notReprocessable": 0,
  "truncated": false
}
DELETE /webhook-domains/{webhookId} Remover webhook ▼

Parâmetros

CampoOndeTipoDescrição
idpathuuidobrigatórioWebhook
Resposta
204 sem corpo

⚡ Batches (lote em massa)

Gera um envelope por signatário variável, todos com os mesmos documentos e os mesmos signatários fixos. Exemplo: o mesmo termo para 300 colaboradores, cada um no seu envelope, com o RH assinando todos.

Etapas

  1. Criar o lote.
  2. Adicionar os documentos do lote (cada um gera uma URL de upload, como em Documentos).
  3. Adicionar signatários: fixed: true entra em todos os envelopes; fixed: false gera um envelope para cada.
  4. (Opcional) Definir as posições dos campos em cada documento.
  5. Processar: os envelopes são criados, lacrados e enviados.

Nas rotas de lote data é um objeto. O companyId que aparece em algumas URLs é o da sua empresa; ele vem na resposta da criação do lote (a collection guarda sozinha).

Atenção às posições no lote: cada campo definido no documento do lote é aplicado a todos os signatários de cada envelope, na mesma posição. Defina ao menos 2 campos por documento.


POST /batches Criar lote Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
data.namebodystringobrigatório
data.descriptionbodystringobrigatório
Body
{
  "data": {
    "name": "Termo de confidencialidade - Out/2026",
    "description": "Envio para todos os colaboradores"
  }
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Termo de confidencialidade - Out/2026",
      "description": "Envio para todos os colaboradores",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "DRAFT"
    }
  ]
}
POST /batches-document Adicionar documento ao lote (gera URL de upload) Idempotency-Key ▼

Cria o documento do lote e devolve a URL de upload (5 minutos). Envie o PDF com PUT nessa URL, igual a Documentos.

Parâmetros

CampoOndeTipoDescrição
data.batchIdbodyuuidobrigatórioLote
data.aliasbodystringobrigatórioNome do documento
Body
{
  "data": {
    "batchId": "<batchId>",
    "alias": "Termo de confidencialidade.pdf"
  }
}
Resposta 201
{
  "statusCode": 201,
  "message": "Successfully create document",
  "data": {
    "documents": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "alias": "Termo de confidencialidade.pdf",
        "url": "https://<bucket>.s3.amazonaws.com/...?X-Amz-Expires=300&..."
      }
    ]
  }
}
PUT {uploadUrl} Enviar o PDF do lote sem Authorization ▼

Corpo binário com o PDF, sem Authorization. Mesmas regras do upload de documentos.

Resposta
200 com corpo vazio.
POST /batches-signer Adicionar signatário ao lote Idempotency-Key ▼

Adicione um por chamada. fixed: true = entra em todos os envelopes (ex.: o RH). fixed: false = cada um gera um envelope.

Parâmetros

CampoOndeTipoDescrição
data.batchIdbodyuuidobrigatórioLote
data.emailbodystringobrigatório
data.fullNamebodystringopcional
data.signatureTypebodyenumobrigatórioTipos de signatário, exceto CARBON_COPY
data.fixedbodybooleanopcionalPadrão false
data.orderbodyintegeropcional
data.requirePersonalDocumentbodybooleanopcionalPadrão false
data.requireEmailTokenbodybooleanopcionalPadrão false
Body
{
  "data": {
    "batchId": "<batchId>",
    "fixed": false,
    "signatureType": "PARTY",
    "email": "colaborador1@exemplo.com.br",
    "fullName": "Colaborador Um"
  }
}
Resposta 201
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fixed": false
    }
  ]
}
GET /batches-signer/{batchId} Listar signatários do lote ▼

Parâmetros

CampoOndeTipoDescrição
batchIdpathuuidobrigatórioLote
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fixed": false,
      "envelopeSigner": {
        "order": 0,
        "signatureType": "PARTY"
      }
    }
  ]
}
PUT /batches-document Definir posições dos campos no documento do lote ▼

Define os campos do documento. Coordenadas iguais às de Campos de assinatura (frações 0 a 1, a partir do canto superior esquerdo). envelopeDocumentId é o id do documento do lote; envelopeSignerId é o signerId de um signatário do lote.

Parâmetros

CampoOndeTipoDescrição
data.batchIdbodyuuidobrigatórioLote
data.documentIdbodyuuidobrigatórioDocumento do lote
data.tags[]bodyarrayobrigatóriofixed, envelopeSignerId, envelopeDocumentId, elementType, page, axisX, axisY, angle
Body
{
  "data": {
    "batchId": "<batchId>",
    "documentId": "<batchDocumentId>",
    "tags": [
      {
        "fixed": false,
        "envelopeSignerId": "<batchSignerId>",
        "envelopeDocumentId": "<batchDocumentId>",
        "elementType": "SIGNATURE",
        "page": 1,
        "axisX": 0.1,
        "axisY": 0.8,
        "angle": 0
      },
      {
        "fixed": false,
        "envelopeSignerId": "<batchSignerId>",
        "envelopeDocumentId": "<batchDocumentId>",
        "elementType": "FULL_NAME",
        "page": 1,
        "axisX": 0.1,
        "axisY": 0.88,
        "angle": 0
      }
    ]
  }
}
Resposta 200
{
  "totalElements": 1,
  "entities": [
    {
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
GET /batches-document Listar documentos do lote ▼

Parâmetros

CampoOndeTipoDescrição
filtersquerystringobrigatóriobatchId:<uuid>
Resposta 200
{
  "totalElements": 1,
  "batchesDocuments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tags": "[...]"
    }
  ]
}
POST /batches-envelopes/{companyId}/{batchId} Processar lote Idempotency-Key ▼

Cria um envelope por signatário variável, adiciona documentos, signatários fixos e campos, lacra e envia. O lote precisa estar em DRAFT. Créditos são debitados por envelope.

Parâmetros

CampoOndeTipoDescrição
companyIdpathuuidobrigatórioSua empresa
batchIdpathuuidobrigatórioLote

Erros comuns

  • 400 Batch not found
  • 400 Signers not found
Resposta
201 com corpo vazio. Acompanhe os envelopes em `GET /v1/envelopes`.
GET /batches/{companyId} Listar lotes ▼

Parâmetros

CampoOndeTipoDescrição
companyIdpathuuidobrigatórioSua empresa
Resposta 200
{
  "totalElements": 1,
  "batches": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Termo de confidencialidade - Out/2026",
      "status": "PROCESS",
      "createdAt": "2026-10-13T12: 00: 00.000Z"
    }
  ]
}
POST /batches-envelopes/resend-request/{batchId}/{batchSignerId} Reenviar convite de um signatário do lote Idempotency-Key ▼

Parâmetros

CampoOndeTipoDescrição
batchIdpathuuidobrigatórioLote
signerIdpathuuidobrigatórioSignatário
Resposta
201 com corpo vazio.
DELETE /batches-signer/{companyId}/{batchId}/{batchSignerId} Remover signatário do lote ▼

Parâmetros

CampoOndeTipoDescrição
companyIdpathuuidobrigatório
batchIdpathuuidobrigatório
signerIdpathuuidobrigatórioO signerId do signatário
DELETE /batches-document Remover documento do lote ▼

Parâmetros

CampoOndeTipoDescrição
data.batchIdbodyuuidobrigatório
data.documentIdbodyuuidobrigatório
Body
{
  "data": {
    "batchId": "<batchId>",
    "documentId": "<batchDocumentId>"
  }
}
DELETE /batches/{companyId}/{batchId} Excluir lote ▼

Exclui o lote com seus documentos, signatários e modelos. Envelopes já gerados não são afetados.

Parâmetros

CampoOndeTipoDescrição
companyIdpathuuidobrigatório
batchIdpathuuidobrigatório
POST /batches-template/{batchId}/{companyId} Lote com modelo: vincular modelo Idempotency-Key ▼

Em vez de PDF fixo, o lote usa um modelo .docx preenchido por signatário a partir de uma planilha (próxima rota).

Parâmetros

CampoOndeTipoDescrição
batchIdpathuuidobrigatório
companyIdpathuuidobrigatório
data.templateIdbodyuuidobrigatórioModelo

Erros comuns

  • 400 Document already exists for this batch
Body
{
  "data": {
    "templateId": "<templateId>"
  }
}
Resposta 201
{
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
POST /batches-template/upload-excel/{batchId}/{companyId}/{templateId} Lote com modelo: enviar planilha ▼

Envio multipart/form-data com o campo file. A planilha precisa de uma coluna email e uma coluna para cada campo do modelo. Cada linha preenche o modelo do signatário (variável, já adicionado ao lote) com aquele e-mail; linhas sem signatário correspondente são ignoradas.

Parâmetros

CampoOndeTipoDescrição
fileformarquivoobrigatório.xlsx

Erros comuns

  • 400 Key e-mail not found
  • 400 No data found in the Excel file
Body (multipart/form-data)
file: <Planilha .xlsx>
Resposta 201
{
  "entities": [
    {
      "message": "Excel file processed successfully"
    }
  ]
}
GET /batches-template/{batchId}/{companyId} Lote com modelo: listar modelos do lote ▼
Resposta 200
{
  "entities": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Contrato CLT",
      "keys": []
    }
  ]
}
DELETE /batches-template/{batchId}/{companyId}/{templateId} Lote com modelo: remover modelo ▼
POST /batches-envelopes/resend-validation/{batchId}/{batchSignerId} Lote com modelo: reenviar pedido de conferência de dados Idempotency-Key ▼

No lote com modelo, cada signatário confere os próprios dados antes de assinar. Esta rota reenvia esse pedido.

Resposta
201 com corpo vazio.