{"info":{"_postman_id":"bb3a677b-3436-4705-87d9-cfc04429f106","name":"Assina Ai","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"2588659","collectionId":"bb3a677b-3436-4705-87d9-cfc04429f106","publishedId":"2sBXc7LjGn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5d3fd3"},"publishDate":"2026-04-27T23:01:55.000Z"},"item":[{"name":"Autenticação","item":[],"id":"0a2c1636-a4b7-4e59-bdc8-253b23d8df75","description":"

Token de API (Estático)

Este método de autenticação utiliza um token fixo gerado no painel da Assina AI. Diferente de tokens temporários (OAuth2), este token não expira automaticamente, simplificando a integração em sistemas backend e automações.

Como autenticar

Adicione o header Authorization em cada requisição com o formato:

Authorization: Bearer sk_live_xxxxxxxx\n

Nesta collection, o header é configurado automaticamente via autenticação de nível de collection. Basta definir o valor da variável api_token:

Clique em ... na collection → Edit
Acesse a aba Variables
Substitua o valor de api_token pelo seu token real

Onde obter seu token

Acesse o Painel da Assina AI → Configurações → Integrações → API Keys.

⚠️ Nota de Segurança: Nunca exponha seu token em código frontend público, repositórios abertos ou logs de sistema.

\n","_postman_id":"0a2c1636-a4b7-4e59-bdc8-253b23d8df75"},{"name":"Templates","item":[{"name":"Criar documento via Modelo","id":"c3ea2f71-577e-4a09-8c73-ea06aeee6b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"signatures\": [\n {\n \"recipient\": {\n \"name\": \"Funcionario\",\n \"email\": \"funcionario@empresa.com\",\n \"phone\": \"\",\n \"routingOrder\": 1,\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n },\n {\n \"recipient\": {\n \"name\": \"Gerente\",\n \"email\": \"gerente@empresa.com\",\n \"phone\": \"\",\n \"routingOrder\": 2,\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"FUNCIONARIO\",\n \"value\": \"José Luiz de Oliveira\"\n },\n {\n \"name\": \"FUNCIONARIO_CPF\",\n \"value\": \"072.763.526-15\"\n }\n ],\n \"documentSendConfig\": {\n \"documentName\": \"Contrato de Trabalho — José Luiz\",\n \"customEmailMessage\": \"Por favor, assine o documento abaixo.\",\n \"signatureDeadline\": \"2026-06-30T23:59:00.000Z\",\n \"sendReminders\": \"EVERY_3_DAYS\",\n \"observers\": []\n },\n \"folderId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/template/create-envelope/{{template_id}}","description":"

Criar Documento via Modelo (Template DOCX)

Gera um novo documento a partir de um modelo .docx pré-existente. O sistema realiza a fusão (merge) dos dados enviados no corpo da requisição com as variáveis definidas no modelo.

POST {{base_url}}/v1/template/create-envelope/{{template_id}}

Pré-requisitos

O modelo deve ter sido criado previamente no painel web da Assina AI (Menu → Templates).
As variáveis no modelo devem ser definidas com o formato {{NOME_VARIAVEL}}.
Importante: A substituição dinâmica é exclusiva para arquivos .docx. Modelos PDF não são compatíveis.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
signatures*	array	Lista de signatários do documento.
signatures[].recipient.name*	string	Nome completo do signatário.
signatures[].recipient.email	string	E-mail. Obrigatório se `senderType = EMAIL`.
signatures[].recipient.phone	string	Telefone com DDD. Obrigatório se `senderType = WHATSAPP`.
signatures[].recipient.routingOrder*	integer	Ordem de assinatura (1 = primeiro).
signatures[].recipient.action*	enum	`SIGN`, `APPROVE`, `REVIEW`, `WITNESS`, `RECOGNIZE`
signatures[].recipient.senderType*	enum	`EMAIL`, `WHATSAPP`
signatures[].recipient.authenticationType*	enum	`DEFAULT_SIGN`, `SELFIE_PHOTO`, `SELFIE_PHOTO_DOCUMENT`, `SMS_CODE`, `CERTIFICATE`
variables*	array	Variáveis para substituição no template. Envie `[]` se não houver.
variables[].name*	string	Nome da variável no modelo (ex: `NOME_CLIENTE`).
variables[].value*	string	Valor a ser substituído.
documentSendConfig.documentName*	string	Título do documento gerado.
documentSendConfig.signatureDeadline	DateTime	Prazo de assinatura. ISO 8601: `2026-06-30T23:59:00.000Z`
documentSendConfig.sendReminders	enum	`EVERY_DAY`, `EVERY_3_DAYS`, `EVERY_WEEK`, `NEVER`
documentSendConfig.customEmailMessage	string	Mensagem personalizada no e-mail de convite.
documentSendConfig.observers	array	E-mails de observadores (recebem cópia das notificações).
folderId	string	ID da pasta de destino. `null` = raiz.

Response `200 OK`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	string	ID único do envelope criado.
status	string	Ex: `SENT_FOR_SIGNATURE`
templateId	string	ID do template de origem.
file.name	string	Nome do arquivo gerado.
file.latestMaster	string	Link temporário do documento processado (expira em 90 minutos).
createdAt	string	Data/hora da criação (ISO 8601).

\n
⚠️ Links temporários expiram em 90 minutos. Faça o download imediatamente se necessário.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","template","create-envelope","{{template_id}}"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"08d2931f-5c68-4c5b-baa5-f42c544c7fe5","name":"200 OK — Documento criado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"body":{"mode":"raw","raw":"{\n \"signatures\": [\n {\n \"recipient\": {\n \"name\": \"Funcionario\",\n \"email\": \"funcionario@empresa.com\",\n \"phone\": \"\",\n \"routingOrder\": 1,\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n },\n {\n \"recipient\": {\n \"name\": \"Gerente\",\n \"email\": \"gerente@empresa.com\",\n \"phone\": \"\",\n \"routingOrder\": 2,\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"FUNCIONARIO\",\n \"value\": \"José Luiz de Oliveira\"\n },\n {\n \"name\": \"FUNCIONARIO_CPF\",\n \"value\": \"072.763.526-15\"\n }\n ],\n \"documentSendConfig\": {\n \"documentName\": \"Contrato de Trabalho — José Luiz\",\n \"customEmailMessage\": \"Por favor, assine o documento abaixo.\",\n \"signatureDeadline\": \"2026-06-30T23:59:00.000Z\",\n \"sendReminders\": \"EVERY_3_DAYS\",\n \"observers\": []\n },\n \"folderId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/template/create-envelope/{{template_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6983d5216505ab4c80dd9f7c\",\n \"status\": \"SENT_FOR_SIGNATURE\",\n \"templateId\": \"697a9fa1d0a31b0ecad6aa65\",\n \"file\": {\n \"name\": \"Contrato_de_Trabalho_Jose_Luiz.docx\",\n \"latestMaster\": \"https://assinaai.s3.amazonaws.com/tenant-envelope-27-04-2026-bc11/original-Contrato.pdf\"\n },\n \"createdAt\": \"2026-04-27T20:24:16.889488\"\n}"}],"_postman_id":"c3ea2f71-577e-4a09-8c73-ea06aeee6b55"},{"name":"Listar","id":"0b3c0f6f-16a3-4dab-b6ef-f7d491c82173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer sk_live_**","type":"text"}],"url":"https://api.assinaai.com/api/v1/template/list","description":"

Listar templates criados

\n","urlObject":{"protocol":"https","path":["api","v1","template","list"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"831890ec-e96f-47d6-9261-cd54c78cc671","name":"200 OK — Listar","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"url":"https://api.assinaai.com/api/v1/template/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Primeiro Template\",\n \"id\": \"69c174d2c80978a2940f53e7\"\n },\n {\n \"name\": \"CONTRATO\",\n \"id\": \"6940021149d6a2693da0c535\"\n }\n]"}],"_postman_id":"0b3c0f6f-16a3-4dab-b6ef-f7d491c82173"}],"id":"d8e75e2a-eb2f-4043-8bcd-208b1e6f777d","description":"

Templates

Endpoints para criação de documentos a partir de modelos dinâmicos .docx pré-configurados no painel da Assina AI.

Pré-requisitos:

O modelo deve existir no painel (Menu → Templates).
Apenas arquivos .docx suportam substituição dinâmica de variáveis.
Modelos PDF não são compatíveis com este fluxo.

\n","_postman_id":"d8e75e2a-eb2f-4043-8bcd-208b1e6f777d"},{"name":"Envelopes","item":[{"name":"Criar Envelope (upload PDF)","id":"3272ef0a-df40-4114-b0ca-5456e1a02211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"

Arquivo PDF a ser enviado para assinatura (máx. 5MB).

\n","value":null},{"key":"envelope","type":"text","contentType":"application/json","value":"{\"signatures\":[{\"recipient\":{\"name\":\"José \",\"lastname\":\"Oliveira\",\"email\":\"jose@teste.com\",\"routingOrder\":1,\"action\":\"SIGN\",\"senderType\":\"EMAIL\",\"authenticationType\":\"DEFAULT_SIGN\",\"signaturePositions\":[{\"pageNumber\":3,\"x\":42.35229046085771,\"y\":45.874522854066754,\"element\":\"SIGNATURE\"},{\"pageNumber\":2,\"x\":32.617584892242654,\"y\":97.28323941889568,\"element\":\"INITIALS\"}]}}],\"documentSendConfig\":{\"documentName\":\"TERMO_DE_CONFIDENCIALIDADE_E_PROTECAO_DE_DADOS_NDA.pdf\",\"emailSubject\":\"\",\"customEmailMessage\":\"\",\"observers\":[],\"signatureDeadline\":\"2026-05-27T12:50:35.813Z\",\"sendReminders\":\"EVERY_3_DAYS\"},\"status\":\"SENT_FOR_SIGNATURE\",\"folderId\":null}","description":"

JSON com os dados do envelope (destinatários, configurações).

\n"}]},"url":"https://api.assinaai.com/api/v1/envelopes/create","description":"

Criar Envelope de Assinatura

Envie um documento PDF para um ou mais destinatários assinarem eletronicamente. Suporta assinatura sequencial, paralela, múltiplos tipos de autenticação e notificações via e-mail ou WhatsApp.

POST https://api.assinaai.com/api/v1/envelopes/create

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
Authorization*	string	`Bearer {{api_token}}` (herdado da collection)
Content-Type*	string	`multipart/form-data` (definido automaticamente pelo Postman)

Request (multipart/form-data)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Part	Type	Description
file*	binary	Arquivo PDF. Máximo: 5MB.
envelope*	application/json	JSON com destinatários e configurações do envelope.

documentSendConfig

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
documentName*	string	Nome exibido ao destinatário na notificação e tela de assinatura.
customEmailMessage	string	Mensagem personalizada no e-mail. Default: `\"\"`
signatureDeadline	DateTime	Prazo de assinatura. ISO 8601: `2026-06-30T23:59:00.000Z`
sendReminders	enum	`EVERY_DAY`
observers	array	E-mails que recebem cópia das notificações (máx. 20). Default: `[]`

recipient

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
name*	string	Nome completo do destinatário.
email	string	E-mail. Obrigatório se `senderType = EMAIL`.
phone	string	Telefone com DDD (somente dígitos). Obrigatório se `senderType = WHATSAPP`.
cpf	string	CPF do destinatário. Formato: `000.000.000-00`.
routingOrder*	integer	Ordem de assinatura. `1` = primeiro a receber. Mesmo valor = paralelo.
action*	enum	`SIGN`
senderType*	enum	`EMAIL`
authenticationType*	enum	`DEFAULT_SIGN`
signaturePositions*	array	Posições dos elementos no documento. Mínimo: 1 item.

signaturePositions[]

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
element*	enum	`SIGNATURE`
pageNumber*	integer	Número da página (começa em `1`).
x*	double	Posição horizontal em % da largura da página (`0.0` a `100.0`).
y*	double	Posição vertical em % da altura da página (`0.0` a `100.0`).

Dicas

Sequencial: Use routingOrder crescente (1, 2, 3...). Cada destinatário só é notificado após o anterior concluir.
\n
Paralelo: Use routingOrder: 1 para todos. Todos recebem a notificação simultaneamente.
\n
Rascunho: Não inclua documentSendConfig.sendReminders ou inclua status: DRAFT para salvar sem enviar.
\n
Use o token retornado na resposta para construir o link de assinatura: https://app.assinaai.com/sign/{token}
\n

Responses

201 Created — Envelope criado e notificações enviadas.

400 Bad Request — JSON inválido ou campos obrigatórios ausentes.

401 Unauthorized — Token ausente ou inválido.

422 Unprocessable Entity — Dados inválidos (ex: email ausente com senderType = EMAIL).

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","create"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"f1f6baaa-c994-4dd7-abd1-2f0cfd7b1644","name":"201 Created — Envelope criado","originalRequest":{"method":"POST","header":[{"key":"Accept-Charset","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr**","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"envelope","type":"text","contentType":"application/json","value":"{\"signatures\":[{\"recipient\":{\"name\":\"José \",\"lastname\":\"Oliveira\",\"email\":\"jose@teste.com\",\"routingOrder\":1,\"action\":\"SIGN\",\"senderType\":\"EMAIL\",\"authenticationType\":\"DEFAULT_SIGN\",\"signaturePositions\":[{\"pageNumber\":3,\"x\":42.35229046085771,\"y\":45.874522854066754,\"element\":\"SIGNATURE\"},{\"pageNumber\":2,\"x\":32.617584892242654,\"y\":97.28323941889568,\"element\":\"INITIALS\"}]}}],\"documentSendConfig\":{\"documentName\":\"TERMO_DE_CONFIDENCIALIDADE_E_PROTECAO_DE_DADOS_NDA.pdf\",\"emailSubject\":\"\",\"customEmailMessage\":\"\",\"observers\":[],\"signatureDeadline\":\"2026-05-27T12:50:35.813Z\",\"sendReminders\":\"EVERY_3_DAYS\"},\"status\":\"SENT_FOR_SIGNATURE\",\"folderId\":null}"}]},"url":"https://api.assinaai.com/api/v1/envelopes/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"69ef6e1f9dabb2b11f412cc0\",\n \"status\": \"SENT_FOR_SIGNATURE\",\n \"tenantId\": \"empresa-0d49\",\n \"createdAt\": \"2026-04-27T11:09:35.572Z\",\n \"signatures\": [\n {\n \"id\": \"173c8a30d0413f0c0ecea8...\",\n \"createdAt\": \"2026-04-27T14:09:35.564Z\",\n \"recipient\": {\n \"id\": \"57259dbc-4359-4557-af23-98cbd68fabf9\",\n \"name\": \"João Silva\",\n \"email\": \"joao@empresa.com\",\n \"status\": \"PENDING\",\n \"routingOrder\": 1,\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\",\n \"token\": \"lU3nzLXQrqiMCkOqAlaoRR9dQiB01A\",\n \"linkExpirationAt\": \"2026-05-27T11:09:35.572Z\",\n \"signaturePositions\": [\n { \"element\": \"SIGNATURE\", \"pageNumber\": 1, \"x\": 42.35, \"y\": 85.0, \"z\": 0 }\n ]\n },\n \"emailEvents\": [],\n \"whatsAppEvents\": []\n }\n ],\n \"documentSendConfig\": {\n \"documentName\": \"Contrato de Prestação de Serviços\",\n \"signatureDeadline\": \"2026-06-30\",\n \"sendReminders\": \"EVERY_3_DAYS\",\n \"observers\": []\n },\n \"file\": {\n \"name\": \"contrato.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 84190\n },\n \"auditTrail\": [\n {\n \"eventType\": \"ENVELOPE_CREATED\",\n \"eventTimestamp\": \"2026-04-27T14:09:35.582Z\",\n \"details\": \"Envelope criado e preparado para envio.\"\n },\n {\n \"eventType\": \"RECIPIENT_NOTIFICATION_SENT\",\n \"eventTimestamp\": \"2026-04-27T14:09:35.583Z\",\n \"recipientEmail\": \"joao@empresa.com\",\n \"senderType\": \"EMAIL\",\n \"details\": \"Notificação enviada para o destinatário.\"\n }\n ]\n}"}],"_postman_id":"3272ef0a-df40-4114-b0ca-5456e1a02211"},{"name":"Listar Envelopes com Filtros","id":"7e406473-50a4-4c03-8ad4-93d4a43dbe63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.assinaai.com/api/v1/envelopes/filter/page?page=0&size=20&sort=createdAt,desc","description":"

Listar Envelopes com Filtros

Retorna uma lista paginada de todos os envelopes do tenant autenticado. Suporta filtragem por status, período, tags, template e busca livre.

GET https://api.assinaai.com/api/v1/envelopes/filter/page

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Obrigatório	Description
page	integer	Não	Número da página (base 0). Default: `0`
size	integer	Não	Itens por página. Default: `20`
sort	string	Não	Ordenação. Ex: `createdAt,desc`
term	string	Não	Busca livre (nome, destinatário).
status	string	Não	Um ou mais status separados por vírgula.
tags	string	Não	Tags separadas por vírgula.
startDate	string	Não	Data inicial (`yyyy-MM-dd`).
endDate	string	Não	Data final (`yyyy-MM-dd`).
templateId	string	Não	Filtra por template de origem.

Valores de status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
`DRAFT`	Rascunho
`SENT_FOR_SIGNATURE`	Enviado para assinatura
`PARTIALLY_SIGNED`	Parcialmente assinado
`COMPLETED`	Concluído (todas as assinaturas coletadas)
`CANCELED`	Cancelado
`DECLINED`	Declinado por um ou mais signatários
`EXPIRED`	Prazo expirado
`SCHEDULED`	Agendado

Response `200 OK`

Retorna objeto paginado com os envelopes encontrados.

{\n  \"content\": [...],\n  \"totalElements\": 42,\n  \"totalPages\": 3,\n  \"size\": 20,\n  \"number\": 0\n}\n\n

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","filter","page"],"host":["api","assinaai","com"],"query":[{"description":{"content":"

Número da página (base 0).

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Itens por página.

\n","type":"text/plain"},"key":"size","value":"20"},{"description":{"content":"

Campo e direção de ordenação. Ex: createdAt,desc

\n","type":"text/plain"},"key":"sort","value":"createdAt,desc"},{"disabled":true,"description":{"content":"

Busca livre por nome do documento ou destinatário.

\n","type":"text/plain"},"key":"term","value":""},{"disabled":true,"description":{"content":"

Filtro por status. Múltiplos separados por vírgula. Valores: DRAFT, SENT_FOR_SIGNATURE, PARTIALLY_SIGNED, COMPLETED, CANCELED, DECLINED, EXPIRED, ARCHIVED, DELETED, SCHEDULED.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Tags separadas por vírgula. Ex: contrato,rh

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Data inicial do período. Formato: yyyy-MM-dd

\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"

Data final do período. Formato: yyyy-MM-dd

\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"

Filtra apenas envelopes gerados a partir deste template.

\n","type":"text/plain"},"key":"templateId","value":""}],"variable":[]}},"response":[{"id":"019bbdc7-da7c-449f-9c12-e74a3a03a752","name":"200 OK — Lista paginada","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/envelopes/filter/page?page=0&size=20&sort=createdAt,desc","host":["{{base_url}}"],"path":["v1","envelopes","filter","page"],"query":[{"key":"page","value":"0"},{"key":"size","value":"20"},{"key":"sort","value":"createdAt,desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": \"69ef6e1f9dabb2b11f412cc0\",\n \"status\": \"SENT_FOR_SIGNATURE\",\n \"createdAt\": \"2026-04-27T11:09:35.572Z\",\n \"completedAt\": null,\n \"documentSendConfig\": {\n \"documentName\": \"Contrato de Prestação de Serviços\"\n },\n \"signatures\": [\n {\n \"recipient\": {\n \"name\": \"João Silva\",\n \"email\": \"joao@empresa.com\",\n \"status\": \"PENDING\"\n }\n }\n ]\n }\n ],\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"size\": 20,\n \"number\": 0,\n \"first\": true,\n \"last\": true\n}"}],"_postman_id":"7e406473-50a4-4c03-8ad4-93d4a43dbe63"},{"name":"Buscar Envelope por ID","id":"bb1cdbd4-4bc1-42c7-9696-805be787661f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.assinaai.com/api/v1/envelopes/69ef673df88976056110c6d0","description":"

Buscar Envelope por ID

Retorna os detalhes completos de um envelope, incluindo destinatários, status de cada assinatura, audit trail e uma URL temporária pré-assinada para acesso ao arquivo original (válida por 90 minutos).

GET https://api.assinaai.com/api/v1/envelopes/{{envelope_id}}

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
envelope_id*	string	ID único do envelope.

Response `200 OK`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	string	ID único do envelope.
status	enum	Status atual do envelope.
file.s3TempFileName	string	URL temporária do arquivo (expira em 90 min).
signatures	array	Lista de signatários com status individual.
auditTrail	array	Histórico completo de eventos do envelope.

Response `404 Not Found`

Envelope não encontrado ou não pertence ao tenant autenticado.

\n
⚠️ A URL em file.s3TempFileName expira em 90 minutos. Faça o download se precisar armazenar o arquivo.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","69ef673df88976056110c6d0"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"54c7cfdf-c469-4e81-b255-cca988abc6b1","name":"200 OK — Envelope encontrado","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/envelopes/{{envelope_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"69ef6e1f9dabb2b11f412cc0\",\n \"status\": \"SENT_FOR_SIGNATURE\",\n \"tenantId\": \"empresa-0d49\",\n \"createdAt\": \"2026-04-27T11:09:35.572Z\",\n \"completedAt\": null,\n \"file\": {\n \"name\": \"contrato.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 84190,\n \"s3TempFileName\": \"https://assinaai.s3.amazonaws.com/signed-url-valid-90min...\"\n },\n \"documentSendConfig\": {\n \"documentName\": \"Contrato de Prestação de Serviços\",\n \"signatureDeadline\": \"2026-06-30\",\n \"sendReminders\": \"EVERY_3_DAYS\",\n \"observers\": []\n },\n \"signatures\": [\n {\n \"recipient\": {\n \"id\": \"57259dbc-4359-4557-af23-98cbd68fabf9\",\n \"name\": \"João Silva\",\n \"email\": \"joao@empresa.com\",\n \"status\": \"PENDING\",\n \"routingOrder\": 1,\n \"linkExpirationAt\": \"2026-05-27T11:09:35.572Z\"\n }\n }\n ],\n \"auditTrail\": [\n {\n \"eventType\": \"ENVELOPE_CREATED\",\n \"eventTimestamp\": \"2026-04-27T14:09:35.582Z\",\n \"details\": \"Envelope criado e preparado para envio.\"\n }\n ]\n}"},{"id":"0cd0134b-f568-40e2-ab41-ac0d83fcfaa9","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/envelopes/id-inexistente"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bb1cdbd4-4bc1-42c7-9696-805be787661f"},{"name":"Cancelar Envelope (Soft Delete)","id":"5a4fd349-640f-463c-a9e8-aaaa27ff4c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.assinaai.com/api/v1/envelopes/soft-delete/69ef673df88976056110c6d0","description":"

Cancelar Envelope (Soft Delete)

Remove logicamente um envelope, sem exclusão permanente do banco de dados. O envelope permanece auditável.

Opcionalmente, informe recipientId para remover apenas a associação de um destinatário específico, mantendo o envelope ativo para os demais.

DELETE https://api.assinaai.com/api/v1/envelopes/soft-delete/{{envelope_id}}

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
envelope_id*	string	ID único do envelope.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
recipientId	string	Se informado, cancela apenas este destinatário.

Response `200 OK`

Corpo: \"Ok\"

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","soft-delete","69ef673df88976056110c6d0"],"host":["api","assinaai","com"],"query":[{"disabled":true,"description":{"content":"

Opcional. Se informado, remove apenas este destinatário do envelope (sem cancelar o envelope inteiro).

\n","type":"text/plain"},"key":"recipientId","value":""}],"variable":[]}},"response":[{"id":"85c72db8-f581-4a41-bee4-e5a6d2ef88b6","name":"200 OK — Cancelado","originalRequest":{"method":"DELETE","header":[],"url":"https://api.assinaai.com/api/v1/envelopes/soft-delete/69ef6e1f9dabb2b11f412cc0"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"\"Ok\""}],"_postman_id":"5a4fd349-640f-463c-a9e8-aaaa27ff4c51"},{"name":"Remover Destinatário do Envelope","id":"e54eedaa-efc1-444a-b0c4-263fcfa06479","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{recipient_id}}\",\n \"name\": \"João Silva\",\n \"email\": \"joao@empresa.com\",\n \"routingOrder\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/envelopes/remove-recipient/69ef673df88976056110c6d0","description":"

Remover Destinatário do Envelope

Remove um destinatário específico de um envelope em andamento.

PUT https://api.assinaai.com/api/v1/envelopes/remove-recipient/{{envelope_id}}

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
envelope_id*	string	ID único do envelope.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id*	string	ID do destinatário a ser removido.
name	string	Nome do destinatário.
email	string	E-mail do destinatário.
routingOrder	integer	Ordem de assinatura do destinatário.

Response `204 No Content`

Destinatário removido com sucesso. Sem corpo na resposta.

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","remove-recipient","69ef673df88976056110c6d0"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"6aa917a9-73ed-45f8-b0ad-ef057e66dc27","name":"204 No Content — Removido","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"8263ba93-6e4c-4115-bf9d-6b26abb99fea\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/envelopes/remove-recipient/69efab539dabb2b11f412cc1"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e54eedaa-efc1-444a-b0c4-263fcfa06479"},{"name":"Reenviar Link de Assinatura","id":"71d2238d-5e41-4d6d-a39a-e0dd355aec2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"senderType\": \"EMAIL\",\n \"email\": \"joao@empresa.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/envelopes/resend-signer-link/69ef673df88976056110c6d069ef66d2458877e66473ade0","description":"

Reenviar Link de Assinatura

Gera um novo token de acesso e reenvia o link de assinatura para um destinatário via e-mail ou WhatsApp.

POST https://api.assinaai.com/api/v1/envelopes/resend-signer-link/{{envelope_id}}/{{recipient_id}}

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
envelope_id*	string	ID único do envelope.
recipient_id*	string	ID único do destinatário.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
senderType*	enum	Canal de reenvio: `EMAIL` ou `WHATSAPP`.
email	string	E-mail de destino. Obrigatório se `senderType = EMAIL`.
phone	string	Telefone com DDD (somente dígitos). Obrigatório se `senderType = WHATSAPP`.

Exemplos

Via E-mail:

{\n  \"senderType\": \"EMAIL\",\n  \"email\": \"joao@empresa.com\"\n}\n\n

Via WhatsApp:

{\n  \"senderType\": \"WHATSAPP\",\n  \"phone\": \"11987654321\"\n}\n\n

Response `200 OK`

Link reenviado com sucesso. Sem corpo na resposta.

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","resend-signer-link","69ef673df88976056110c6d069ef66d2458877e66473ade0"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"f8f9b40f-6533-4716-ac6e-b7bd4252019d","name":"200 OK — Link reenviado (E-mail)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"senderType\": \"EMAIL\",\n \"email\": \"joao@empresa.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/envelopes/resend-signer-link/69efab539dabb2b11f412cc1/6f3e4a7d-46f5-4396-8975-273ba19a1642"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"678b4186-5736-44f7-8ac6-305dbe45c648","name":"200 OK — Link reenviado (WhatsApp)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"senderType\": \"WHATSAPP\",\n \"phone\": \"11987654321\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/envelopes/resend-signer-link/{{envelope_id}}/{{recipient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"71d2238d-5e41-4d6d-a39a-e0dd355aec2f"},{"name":"Obter ou Renovar Link de Assinatura","id":"236d2b00-57a6-4ca4-a7a9-756010b4f6ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.assinaai.com/api/v1/envelopes/refresh-token-signer-email-link/69ef66d2458877e66473ade0/69ef673df88976056110c6d0","description":"

Obter ou Renovar Link de Assinatura

Retorna o link de assinatura vigente para um destinatário. Se o token estiver expirado, gera automaticamente um novo link antes de retorná-lo.

Uso ideal: quando você precisa do link de assinatura para enviar por um canal próprio (CRM, e-mail marketing, automação) sem forçar um reenvio desnecessário.

GET https://api.assinaai.com/api/v1/envelopes`/refresh-token-signer-email-link/{{envelope_id}}/{{recipient_id}}`

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
envelope_id*	string	ID único do envelope.
recipient_id*	string	ID único do destinatário.

Response `200 OK`

Retorna a URL de assinatura como string simples:

https://app.assinaai.com/sign/lU3nzLXQrqiMCkOqAlaoRR9dQiB01A\n\n

\n
Comportamento: Se o token atual não estiver expirado, o mesmo link é retornado sem geração de novo token. Se estiver expirado, um novo token é gerado e o link atualizado é retornado.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","envelopes","refresh-token-signer-email-link","69ef66d2458877e66473ade0","69ef673df88976056110c6d0"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"ab6da727-bdad-4c07-9231-acee473f0958","name":"200 OK — Link de assinatura","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/envelopes/refresh-token-signer-email-link/{{envelope_id}}/{{recipient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"https://app.assinaai.com/sign/lU3nzLXQrqiMCkOqAlaoRR9dQiB01A"}],"_postman_id":"236d2b00-57a6-4ca4-a7a9-756010b4f6ae"}],"id":"24e70115-11c2-42ce-b613-73a437612d9d","description":"

Envelopes

Um envelope é o objeto central da Assina AI — representa um documento enviado para coleta de assinaturas eletrônicas.

Ciclo de vida

DRAFT → SENT_FOR_SIGNATURE → PARTIALLY_SIGNED → COMPLETED\n                          ↘ CANCELED / DECLINED / EXPIRED\n

Endpoints disponíveis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Método	Rota	Descrição
`POST`	`/v1/envelopes/create`	Criar envelope com upload de PDF
`GET`	`/v1/envelopes/filter/page`	Listar envelopes com filtros e paginação
`GET`	`/v1/envelopes/{id}`	Buscar envelope por ID
`DELETE`	`/v1/envelopes/soft-delete/{id}`	Cancelar envelope
`PUT`	`/v1/envelopes/remove-recipient/{envelopeId}`	Remover destinatário
`POST`	`/v1/envelopes/resend-signer-link/{envelopeId}/{recipientId}`	Reenviar link de assinatura
`GET`	`/v1/envelopes/refresh-token-signer-email-link/{envelopeId}/{recipientId}`	Obter ou renovar link de assinatura
`PUT`	`/v1/envelopes/{envelopeId}/signature/recipient/{recipientId}`	Registrar assinatura

","_postman_id":"24e70115-11c2-42ce-b613-73a437612d9d"},{"name":"Webhooks","item":[],"id":"3ad8062b-7e67-4c0a-8cb0-c254e9303f89","description":"

🔔 Webhooks — Assina AI

Webhooks permitem que seu sistema receba notificações em tempo real sobre eventos do ciclo de vida de um envelope, sem precisar fazer polling na API.

Quando um evento ocorre, a Assina AI faz uma requisição POST para a URL que você registrou, com o payload do evento no corpo da requisição.

Tipos de Evento

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

eventType	Quando é disparado	Entrega
`DOCUMENT_CREATED`	Envelope enviado aos destinatários pela primeira vez.	Assíncrona
`DOCUMENT_SIGNED`	Um destinatário completou sua ação (assinou, aprovou, etc.).	Assíncrona
`DOCUMENT_COMPLETED`	Todos os destinatários completaram suas ações.	Síncrona
`ALL_EVENTS`	Recebe os três tipos acima em um único endpoint.	—

Nota: DOCUMENT_COMPLETED é entregue de forma síncrona. Os demais são assíncronos, garantindo que a lentidão do seu endpoint não afete a experiência do signatário.

Estrutura do Payload

Todos os eventos recebem o mesmo formato base. Campos null são omitidos automaticamente.

Raiz

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Sempre presente	Description
`eventId`	string (UUID)	✅	Identificador único do evento. Use para deduplicação em reentregas.
`eventType`	enum	✅	`DOCUMENT_CREATED`
`timestamp`	Instant (ISO 8601)	✅	Data/hora em que o evento foi gerado.
`envelopeId`	string	✅	ID do envelope que gerou o evento.
`tenantId`	string	✅	ID do tenant proprietário do envelope.
`status`	enum	✅	Status atual do envelope. Ver tabela Status do Envelope.
`documentName`	string	✅	Nome do documento definido na configuração de envio.
`title`	string	—	Título do envelope.
`description`	string	—	Descrição do envelope.
`templateId`	string	—	ID do template de origem (quando criado via template).
`folderId`	string	—	Pasta onde o envelope está armazenado.
`createdAt`	LocalDateTime	✅	Data/hora de criação do envelope.
`updatedAt`	LocalDateTime	—	Data/hora da última atualização.
`completedAt`	LocalDateTime	—	Data/hora de conclusão. Presente apenas em `DOCUMENT_COMPLETED`.
`expiresAt`	LocalDate	—	Data de expiração do prazo de assinatura.
`signatureDeadline`	LocalDate	—	Prazo limite para assinatura.
`file`	object	✅	Informações do arquivo.
`signatures`	array	✅	Lista de signatários.

file

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Description
`name`	string	Nome do arquivo.
`type`	string	MIME type. Ex: `application/pdf`
`size`	integer	Tamanho em bytes.
`originalHash`	string	Hash SHA do documento original (integridade).
`finalHash`	string	Hash SHA do documento final. Presente apenas em `DOCUMENT_COMPLETED`.
`documentUrl`	string	URL pré-assinada da versão atual. Expira em 60 minutos.
`signedDocumentUrl`	string	URL pré-assinada do documento totalmente assinado. Presente apenas em `DOCUMENT_COMPLETED`. Expira em 60 minutos.

signatures[]

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Description
`id`	string	ID único da assinatura.
`action`	enum	`SIGN`
`createdAt`	Instant	Data/hora de criação da assinatura.
`recipient`	object	Dados do destinatário.
`signed`	object	Dados da assinatura realizada. `null` se ainda pendente.

recipient

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Description
`id`	string	ID único do destinatário.
`name`	string	Nome do destinatário.
`fullName`	string	Nome completo (quando preenchido pelo signatário).
`email`	string	E-mail do destinatário.
`status`	enum	`PENDING`
`senderType`	enum	`EMAIL`
`authenticationType`	enum	`DEFAULT_SIGN`
`routingOrder`	integer	Ordem de assinatura.

signed

Presente apenas quando o destinatário completou sua ação.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Description
`signedAt`	LocalDateTime	Data/hora exata da assinatura.
`signedDocumentHash`	string	Hash do documento após esta assinatura (rastreabilidade).
`geolocation`	object	Geolocalização no momento da assinatura.

geolocation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Description
`city`	string	Cidade.
`country`	string	País.
`timezone`	string	Fuso horário. Ex: `America/Sao_Paulo`
`latitude`	float	Latitude geográfica.
`longitude`	float	Longitude geográfica.

Exemplos de Payload por Evento

DOCUMENT_CREATED

{ \"eventId\": \"a1b2c3d4-0000-0000-0000-000000000001\", \"eventType\": \"DOCUMENT_CREATED\", \"timestamp\": \"2026-04-28T13:00:00Z\", \"envelopeId\": \"69ef6e1f9dabb2b11f412cc0\", \"tenantId\": \"empresa-0d49\", \"status\": \"SENT_FOR_SIGNATURE\", \"documentName\": \"Contrato de Prestação de Serviços\", \"createdAt\": \"2026-04-28T13:00:00\", \"signatureDeadline\": \"2026-06-30\", \"file\": { \"name\": \"contrato.pdf\", \"type\": \"application/pdf\", \"size\": 84190, \"originalHash\": \"sha256-abc123...\", \"documentUrl\": \"[https://s3.amazonaws.com/presigned-url-60min...\"](https://s3.amazonaws.com/presigned-url-60min...) }, \"signatures\": \\[ { \"id\": \"sig-001\", \"action\": \"SIGN\", \"createdAt\": \"2026-04-28T13:00:00Z\", \"recipient\": { \"id\": \"57259dbc-4359-4557-af23-98cbd68fabf9\", \"name\": \"João Silva\", \"email\": \"[joao@empresa.com](https://mailto:joao@empresa.com)\", \"status\": \"PENDING\", \"senderType\": \"EMAIL\", \"authenticationType\": \"DEFAULT_SIGN\", \"routingOrder\": 1 } }, { \"id\": \"sig-002\", \"action\": \"SIGN\", \"createdAt\": \"2026-04-28T13:00:00Z\", \"recipient\": { \"id\": \"89abc123-0000-0000-0000-000000000002\", \"name\": \"Maria Oliveira\", \"email\": \"[maria@empresa.com](https://mailto:maria@empresa.com)\", \"status\": \"PENDING\", \"senderType\": \"EMAIL\", \"authenticationType\": \"SELFIE_PHOTO\", \"routingOrder\": 2 } } \\]}\n\n

### DOCUMENT_SIGNED\n{ \"eventId\": \"a1b2c3d4-0000-0000-0000-000000000002\", \"eventType\": \"DOCUMENT_SIGNED\", \"timestamp\": \"2026-04-28T14:35:22Z\", \"envelopeId\": \"69ef6e1f9dabb2b11f412cc0\", \"tenantId\": \"empresa-0d49\", \"status\": \"PARTIALLY_SIGNED\", \"documentName\": \"Contrato de Prestação de Serviços\", \"createdAt\": \"2026-04-28T13:00:00\", \"file\": { \"name\": \"contrato.pdf\", \"type\": \"application/pdf\", \"size\": 84190, \"originalHash\": \"sha256-abc123...\", \"documentUrl\": \"[https://s3.amazonaws.com/presigned-url-60min...\"](https://s3.amazonaws.com/presigned-url-60min...) }, \"signatures\": \\[ { \"id\": \"sig-001\", \"action\": \"SIGN\", \"recipient\": { \"id\": \"57259dbc-4359-4557-af23-98cbd68fabf9\", \"name\": \"João Silva\", \"email\": \"[joao@empresa.com](https://mailto:joao@empresa.com)\", \"status\": \"SIGNED\", \"senderType\": \"EMAIL\", \"authenticationType\": \"DEFAULT_SIGN\", \"routingOrder\": 1 }, \"signed\": { \"signedAt\": \"2026-04-28T14:35:22\", \"signedDocumentHash\": \"sha256-def456...\", \"geolocation\": { \"city\": \"São Paulo\", \"country\": \"Brasil\", \"timezone\": \"America/Sao_Paulo\", \"latitude\": -23.5505, \"longitude\": -46.6333 } } }, { \"id\": \"sig-002\", \"action\": \"SIGN\", \"recipient\": { \"id\": \"89abc123-0000-0000-0000-000000000002\", \"name\": \"Maria Oliveira\", \"email\": \"[maria@empresa.com](https://mailto:maria@empresa.com)\", \"status\": \"PENDING\", \"senderType\": \"EMAIL\", \"authenticationType\": \"SELFIE_PHOTO\", \"routingOrder\": 2 } } \\]}\n\n

### DOCUMENT_COMPLETED\n{ \"eventId\": \"a1b2c3d4-0000-0000-0000-000000000003\", \"eventType\": \"DOCUMENT_COMPLETED\", \"timestamp\": \"2026-04-28T16:10:05Z\", \"envelopeId\": \"69ef6e1f9dabb2b11f412cc0\", \"tenantId\": \"empresa-0d49\", \"status\": \"COMPLETED\", \"documentName\": \"Contrato de Prestação de Serviços\", \"createdAt\": \"2026-04-28T13:00:00\", \"completedAt\": \"2026-04-28T16:10:05\", \"file\": { \"name\": \"contrato.pdf\", \"type\": \"application/pdf\", \"size\": 84190, \"originalHash\": \"sha256-abc123...\", \"finalHash\": \"sha256-ghi789...\", \"documentUrl\": \"[https://s3.amazonaws.com/presigned-url-master-60min...\"](https://s3.amazonaws.com/presigned-url-master-60min...), \"signedDocumentUrl\": \"[https://s3.amazonaws.com/presigned-url-final-60min...\"](https://s3.amazonaws.com/presigned-url-final-60min...) }, \"signatures\": \\[ { \"id\": \"sig-001\", \"action\": \"SIGN\", \"recipient\": { \"id\": \"57259dbc-4359-4557-af23-98cbd68fabf9\", \"name\": \"João Silva\", \"email\": \"[joao@empresa.com](https://mailto:joao@empresa.com)\", \"status\": \"SIGNED\", \"routingOrder\": 1 }, \"signed\": { \"signedAt\": \"2026-04-28T14:35:22\", \"signedDocumentHash\": \"sha256-def456...\" } }, { \"id\": \"sig-002\", \"action\": \"SIGN\", \"recipient\": { \"id\": \"89abc123-0000-0000-0000-000000000002\", \"name\": \"Maria Oliveira\", \"email\": \"[maria@empresa.com](https://mailto:maria@empresa.com)\", \"status\": \"SIGNED\", \"routingOrder\": 2 }, \"signed\": { \"signedAt\": \"2026-04-28T16:10:05\", \"signedDocumentHash\": \"sha256-ghi789...\" } } \\]}\n\n

Segurança

Cada requisição de webhook inclui dois headers:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`X-Webhook-Request-Id`	UUID único do evento. Use para idempotência — ignore eventos com o mesmo ID já processado.
`X-Webhook-Signature`	Assinatura `HMAC-SHA256` do corpo em Base64. Valide com o `secret` recebido no cadastro.

A assinatura é gerada com HMAC-SHA256(rawBody, secret). Use o corpo como string bruta, antes de qualquer parse de JSON.

Política de Reentrega (Retry)

Se o seu endpoint não responder com 2xx, a Assina AI reintenta automaticamente com backoff exponencial.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tentativa	Delay
1ª	Imediata
2ª	2 segundos
3ª	4 segundos

Após 3 tentativas falhas, o evento é marcado como FAILED e não é mais reenviado.

Status de um evento

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
`PENDING`	Aguardando envio ou em processo de retry.
`SUCCESS`	Entregue com sucesso (`2xx`).
`FAILED`	Todas as 3 tentativas falharam.

Status do Envelope

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	Description
`DRAFT`	Rascunho (não enviado).
`SENT_FOR_SIGNATURE`	Enviado — aguardando assinaturas.
`PARTIALLY_SIGNED`	Um ou mais destinatários assinaram, mas não todos.
`COMPLETED`	Todas as assinaturas foram coletadas.
`CANCELED`	Cancelado pelo remetente.
`DECLINED`	Um ou mais signatários recusaram.
`EXPIRED`	Prazo de assinatura expirou.
`SCHEDULED`	Agendado para envio futuro.

Boas práticas

Responda rápido, processe depois. Retorne 200 OK imediatamente e processe o evento de forma assíncrona para evitar timeouts e retentativas desnecessárias.

Use eventId para idempotência. Em caso de reentrega você pode receber o mesmo evento mais de uma vez. Verifique se o eventId já foi processado antes de agir.

URLs temporárias expiram em 60 minutos. Os campos documentUrl e signedDocumentUrl são URLs pré-assinadas da AWS S3. Faça o download imediatamente após receber o evento DOCUMENT_COMPLETED.

Valide sempre o X-Webhook-Signature. Nunca processe um webhook sem verificar a assinatura HMAC para garantir a autenticidade da origem.

Registre X-Webhook-Request-Id nos seus logs. Facilita o diagnóstico de falhas junto ao suporte.

\n","_postman_id":"3ad8062b-7e67-4c0a-8cb0-c254e9303f89"},{"name":"Pastas","item":[{"name":"Criar Pasta","id":"3c28b6b7-ed56-48e8-93ca-b0636fb01dbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"body":{"mode":"raw","raw":" {\n\n \"name\": \"Nova Pasta\",\n \"visibility\": \"SHARED\",\n \"type\": \"USER\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/folders/create","description":"

Criar Pasta

POST {{base_url}}/v1/folders/create

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
name*	string	Nome da pasta

Response `200 OK`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	string	ID único da pasta.
name	string	Nome da pasta
visibility	enum	`SHARED, PRIVATE`
type	enum	`USER,TEMPLATE, PAYROLL`

Valores de `visibility`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
`PRIVATE`	Visível apenas para o criador
`SHARED`	Compartilhada com usuários específicos

Valores de `type`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
`USER`	Pasta comum (padrão)
`TEMPLATE`	Pasta de templates
`PAYROLL`	Pasta de folha de pagamento

","urlObject":{"protocol":"https","path":["api","v1","folders","create"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"f94ab264-1ab8-4ad8-9d9d-919852170b49","name":"200 OK — Criar Pasta","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"body":{"mode":"raw","raw":" {\n \n \"name\": \"Nova Pasta\",\n \"visibility\": \"SHARED\",\n \"type\": \"USER\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/folders/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6983d5216505ab4c80dd9f7c\",\n \"name\": \"Nova Pasta\",\n \"visibility\": \"SHARED\",\n \"type\": \"USER\" \n}"}],"_postman_id":"3c28b6b7-ed56-48e8-93ca-b0636fb01dbd"},{"name":"Listar","id":"f521c0f8-6af6-49de-aa0f-2d7e4043d7c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"url":"https://api.assinaai.com/api/v1/folders/list","description":"

Listar pastas criadas

\n","urlObject":{"protocol":"https","path":["api","v1","folders","list"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"ed3440f4-bcb3-4b23-9ebe-a9338291d4ec","name":"200 OK — Listar","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer sk_live_K3l_yIr_**","type":"text"}],"url":"https://api.assinaai.com/api/v1/folders/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":" [ \n {\n \"id\": \"69fc9a338b2f8262347d9a54\",\n \"name\": \"Nova Pasta\",\n \"visibility\": \"SHARED\",\n \"type\": \"USER\"\n }\n \n]"}],"_postman_id":"f521c0f8-6af6-49de-aa0f-2d7e4043d7c0"}],"id":"1ba68507-629b-44c5-a565-1fe7125834d7","description":"

Pastas

Endpoints para criação de pastas para organização dos documentos.

\n","_postman_id":"1ba68507-629b-44c5-a565-1fe7125834d7"}]}

Token de API (Estático)

Como autenticar

Onde obter seu token

Criar Documento via Modelo (Template DOCX)

Pré-requisitos

Request Body

Response 200 OK

Listar templates criados

Templates

Criar Envelope de Assinatura

Headers

Request (multipart/form-data)

documentSendConfig

recipient

signaturePositions[]

Dicas

Responses

Listar Envelopes com Filtros

Query Parameters

Valores de status

Response 200 OK

Buscar Envelope por ID

Path Parameters

Response 200 OK

Response 404 Not Found

Cancelar Envelope (Soft Delete)

Path Parameters

Query Parameters

Response 200 OK

Remover Destinatário do Envelope

Path Parameters

Request Body

Response 204 No Content

Reenviar Link de Assinatura

Path Parameters

Request Body

Exemplos

Response 200 OK

Obter ou Renovar Link de Assinatura

Path Parameters

Response 200 OK

Envelopes

Ciclo de vida

Endpoints disponíveis

🔔 Webhooks — Assina AI

Tipos de Evento

Estrutura do Payload

Raiz

file

signatures[]

recipient

signed

geolocation

Exemplos de Payload por Evento

DOCUMENT_CREATED

Segurança

Política de Reentrega (Retry)

Status de um evento

Status do Envelope

Boas práticas

Criar Pasta

Request Body

Response 200 OK

Valores de visibility

Valores de type

Listar pastas criadas

Pastas

Response `200 OK`

Response `200 OK`

Response `200 OK`

Response `404 Not Found`

Response `200 OK`

Response `204 No Content`

Response `200 OK`

Response `200 OK`

Response `200 OK`

Valores de `visibility`

Valores de `type`