{"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-02-04T22:40:56.000Z"},"item":[{"name":"Autenticação","item":[],"id":"79101672-7e8c-4dc4-8b0b-3e22a042e0c3","description":"

Token de API (Estático)

\n

Este método de autenticação utiliza um token fixo para validar o acesso à API. Diferente de tokens temporários (como OAuth2), este token não expira automaticamente, o que simplifica a implementação em scripts e sistemas backend.

\n

Instruções de Uso

\n

Para autenticar, adicione a chave Authorization ao cabeçalho da sua requisição HTTP com o valor no formato Bearer .

\n
  'headers': {\n    'Content-Type': 'application/json',\n    'Authorization': 'Bearer xxxxx-7893-4087-b4fb-xxxxxx'\n  },\n\n

**
⚠️ Nota de Segurança:** Mantenha seu Token Estático em segredo. Nunca o exponha em códigos front-end públicos ou repositórios abertos.

\n","_postman_id":"79101672-7e8c-4dc4-8b0b-3e22a042e0c3"},{"name":"Templates","item":[{"name":"Criar documento via Modelo 2","id":"1871e253-e645-42e6-9728-1f145b387b57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer sk_live_xxxxxxxxxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"signatures\": [\n {\n \"recipient\": {\n \"name\": \"Funcionario\",\n \"email\": \"funcionario@teste.com\",\n \"phone\": \"\",\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n },\n {\n \"recipient\": {\n \"name\": \"Gerente\",\n \"email\": \"gerente@teste.com\",\n \"phone\": \"\",\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\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\": \"Nome Documento\",\n \"customEmailMessage\": \"\",\n \"signatureDeadline\": \"2026-03-05T21:32:31.799Z\",\n \"sendReminders\": \"EVERY_3_DAYS\"\n },\n \"folderId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.assinaai.com/api/v1/template/create-envelope/{{template_id}}","description":"

Criação de Documento via Modelo Dinâmico (DOCX)

\n

Este endpoint 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 (JSON) com as variáveis definidas no modelo.

\n

Pré-requisitos:

\n\n

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
NameTypeDescription
signaturesarray(Obrigatório) Lista de objetos contendo os signatários ou envolvidos no fluxo do documento.
signatures[].recipientobjectObjeto com os dados do destinatário da ação.
signatures[].recipient.namestring(Obrigatório) Nome completo do signatário/envolvido.
Ex: \"João da Silva\"
signatures[].recipient.emailstringE-mail do signatário. Necessário se senderType for EMAIL ou DEFAULT_SIGN.
signatures[].recipient.phonestringTelefone com DDD. Obrigatório se senderType for WHATSAPP.
signatures[].recipient.actionenum(Obrigatório) Define o papel do usuário no documento.
Valores aceitos:
\"SIGN\" (Assinar)
\"APPROVE\" (Aprovar)
\"REVIEW\" (Revisar)
\"WITNESS\" (Testemunhar)
\"RECOGNIZE\" (Reconhecer Firma)
signatures[].recipient.senderTypeenum(Obrigatório) Canal de envio do link.
Valores aceitos:
\"EMAIL\"
\"WHATSAPP\"
signatures[].recipient.authenticationTypeenum(Obrigatório) Método de validação da identidade.
Valores aceitos:
\"DEFAULT_SIGN\" (Link padrão por e-mail)
\"SMS_CODE\" (Código via SMS)
\"SELFIE_PHOTO\" (Foto do rosto)
\"SELFIE_PHOTO_DOCUMENT\" (Foto + Documento)
\"VIDEO\" (Reconhecimento por vídeo)
\"CERTIFICATE\" (Certificado Digital ICP-Brasil)
variablesarray(Obrigatório) Lista de variáveis para substituição no template DOCX. Envie lista vazia [] se não houver campos.
variables[].namestringNome da variável no modelo (ex: NOME_CLIENTE).
variables[].valuestringValor a ser preenchido (ex: Maria Silva).
documentSendConfigobject(Obrigatório) Configurações de envio e prazos.
documentSendConfig.documentNamestring(Obrigatório) Título do documento que será gerado.
documentSendConfig.signatureDeadlinedate(Obrigatório) Data limite para assinatura (ISO 8601).
Ex: \"2026-03-05T21:32:31.799Z\"
documentSendConfig.sendRemindersenum(Obrigatório) Frequência dos lembretes automáticos.
Valores aceitos:
\"EVERY_DAY\" (Diariamente)
\"EVERY_3_DAYS\" (A cada 3 dias)
\"EVERY_WEEK\" (Semanalmente)
\"NEVER\" (Nunca lembrar)
documentSendConfig.folderIdstring(Opcional) ID da pasta para organização interna.
\n

Response Body (200 OK)

\n

Retorna o identificador do envelope criado e os links temporários para download do arquivo.

\n
\n

⚠️ Atenção sobre Links Temporários

\n
\n

A URL retornada no campo `file.latestMaster` contém o arquivo já processado (com as variáveis substituídas). Este link é assinado e expira em 90 minutos.
Caso seu sistema necessite armazenar o arquivo, recomendamos realizar o download para seu próprio armazenamento (CDN) imediatamente.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
idstringID único do envelope/documento criado.
statusenumEstado atual do processamento.
Ex: \"SENT_FOR_SIGNATURE\".
templateIdstringID do modelo que originou este documento.
createdAtstringData e hora da criação (ISO 8601).
fileobjectObjeto contendo os metadados e links do arquivo.
file.namestringNome do arquivo gerado (incluindo extensão).
file.latestMasterstringLink temporário do documento final processado (com as variáveis substituídas).
\n
","urlObject":{"protocol":"https","path":["api","v1","template","create-envelope","{{template_id}}"],"host":["api","assinaai","com"],"query":[],"variable":[]}},"response":[{"id":"0b2a1742-5388-4a16-ae94-8309e73e064e","name":"Criar documento via Modelo","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer sk_live_xxxxxxxxxxx"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"signatures\": [\n {\n \"recipient\": {\n \"name\": \"Funcionario\",\n \"email\": \"funcionario@teste.com\",\n \"phone\": \"\",\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\n },\n {\n \"recipient\": {\n \"name\": \"Gerente\",\n \"email\": \"gerente@teste.com\",\n \"phone\": \"\",\n \"action\": \"SIGN\",\n \"senderType\": \"EMAIL\",\n \"authenticationType\": \"DEFAULT_SIGN\"\n }\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\": \"Nome Documento\",\n \"customEmailMessage\": \"\",\n \"signatureDeadline\": \"2026-03-05T21:32:31.799Z\",\n \"sendReminders\": \"EVERY_3_DAYS\"\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":"","header":[{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 04 Feb 2026 22:35:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"6983d5216505ab4c80dd9f7c\",\n \"status\": \"SENT_FOR_SIGNATURE\",\n \"templateId\": \"697a9fa1d0a31b0ecad6aa65\",\n \"file\": {\n \"name\": \"N12_.docx\",\n \"latestMaster\": \"https://assinaai.s3.amazonaws.com/envelope-04-02-2026-bc11/original-N12_.docx\",\n \n },\n \"createdAt\": \"2026-02-04T20:24:16.889488\"\n}"}],"_postman_id":"1871e253-e645-42e6-9728-1f145b387b57"}],"id":"478107b3-6dcc-4ae3-b85b-eda12c5fb932","description":"

Criação de Documento via Modelo Dinâmico (DOCX)

\n

Este endpoint 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 (JSON) com as variáveis definidas no modelo.

\n

Pré-requisitos:

\n\n","_postman_id":"478107b3-6dcc-4ae3-b85b-eda12c5fb932"}]}