Documentação da API
Referência para quem integra um sistema ao SigNexo: criar e enviar documentos, acompanhar as assinaturas, receber avisos por webhook e embutir a página de assinatura.
Primeiros passos
Todas as rotas ficam em https://signexo.com.br/api/v1, aceitam e devolvem JSON (Content-Type: application/json), com datas em ISO 8601 (UTC). O corpo JSON pode ter até 4 MB.
Nos exemplos, nomes, e-mails e identificadores são fictícios, e a chave sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA não funciona: troque pela sua.
curl https://signexo.com.br/api/v1/me \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"Resposta: { "organizationId": "...", "environment": "live" | "test" }.
Autenticação
Envie a chave em todas as chamadas, no cabeçalho Authorization: Bearer sgx_…. Quem administra a organização cria e revoga chaves no painel, em Integrações. A chave completa aparece uma única vez, na criação: guarde-a em local seguro e nunca a coloque em página web ou aplicativo distribuído.
- A chave age em nome da organização que a criou e enxerga só os documentos dela.
- Chave ausente, malformada, desconhecida ou revogada recebe a mesma resposta:
401 unauthorized. - O prefixo indica o ambiente:
sgx_live_em produção esgx_test_nos demais.
Erros
Todo erro vem com o código HTTP e um corpo JSON no mesmo formato. Decida pelo code, que é estável; message é um texto em português que pode mudar.
{
"statusCode": 422,
"code": "invalid_input",
"message": "Dados inválidos",
"issues": [{ "path": "recipients.0.email", "message": "E-mail inválido" }]
}| Código | Quando acontece |
|---|---|
401 unauthorized | Chave ausente ou inválida. |
404 not_found | Documento ou pessoa que não existe nesta organização. |
409 not_draft | Tentativa de alterar um documento que já foi enviado. |
422 invalid_input | Entrada inválida; issues lista o campo (path) e o problema. |
422 pdf_rejected | O arquivo não é um PDF aceito (a mensagem diz o motivo). |
413 pdf_too_large | PDF com mais de 20 MB. |
422 not_ready | Falta algo para enviar; problems lista o que falta. |
429 rate_limited | Muitas requisições (veja Limites). |
Na criação em uma chamada, se uma etapa falhar depois de o rascunho existir, o erro traz também envelopeId: corrija pelas rotas específicas, sem criar outro documento.
Limites
- Por chave: 300 requisições por minuto. Acima disso,
429 rate_limited, comretryAfterSecondsno corpo. - Por endereço IP: há também um limite por minuto. As respostas trazem
RateLimit-Limit,RateLimit-RemainingeRateLimit-Reset; ao estourar,429 rate_limitedcom o cabeçalhoRetry-After, em segundos. - Envios por organização: há um teto de documentos enviados a cada 24 horas. Ao atingi-lo, o envio responde
429 org_send_limit, comlimitno corpo. - Por documento: até 20 signatários, 10 pessoas em cópia e 200 campos; PDF de até 20 MB.
Ao receber 429, espere o tempo indicado antes de tentar de novo.
Idempotência
Em POST /envelopes e POST /envelopes/:id/send, envie o cabeçalho Idempotency-Key com um valor único por operação (8 a 200 caracteres ASCII visíveis, sem espaço). Se a mesma requisição for repetida com a mesma chave, por exemplo depois de uma queda de rede, a API devolve a primeira resposta em vez de criar ou enviar de novo.
- A chave vale por 24 horas e é separada por chave de API.
- Mesma chave com corpo diferente:
422 idempotency_mismatch. - Repetição enquanto a primeira ainda está em andamento:
409 idempotency_in_progress. - Se a primeira tentativa falhar, a chave fica livre para tentar de novo.
Documentos
Um documento nasce como rascunho (DRAFT), é enviado (SENT) e termina concluído (COMPLETED), recusado (DECLINED) ou cancelado (VOIDED). As rotas devolvem o documento inteiro: dados, arquivo, pessoas (recipients), campos (fields) e, em rascunho, readiness com o que falta para enviar.
POST/envelopes
Cria o rascunho e, se você mandar, grava o PDF, as pessoas e os campos e já envia.
| Campo | Descrição |
|---|---|
title | Obrigatório. Até 200 caracteres. |
message | Mensagem para quem assina. Até 2.000 caracteres. |
signingOrder | SEQUENTIAL (padrão, uma pessoa depois da outra) ou PARALLEL. |
deadlineDays | Prazo em dias, de 1 a 365. Padrão: 30. |
reminderIntervalDays | Lembrete automático a cada 1, 2, 3 ou 7 dias; nulo para não lembrar. |
redirectUrl | Endereço https oferecido à pessoa, em um botão, depois de assinar. |
externalId | Identificador no seu sistema (até 120). Serve de filtro na listagem. |
metadata | Até 20 pares de texto, devolvidos nos webhooks. |
document | { fileName, contentBase64 }: o PDF em base64, sem prefixo data:. Para arquivo grande, use a rota de upload. |
recipients, fields | Como em Pessoas e campos. |
send | true para enviar em seguida. Exige acceptPermittedUsesVersion. |
curl -X POST https://signexo.com.br/api/v1/envelopes \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-0001-criacao" \
-d '{
"title": "Contrato de exemplo",
"message": "Segue o contrato para assinatura.",
"signingOrder": "SEQUENTIAL",
"deadlineDays": 15,
"externalId": "pedido-0001",
"metadata": { "origem": "loja-exemplo" },
"redirectUrl": "https://loja.example.com/obrigado",
"document": { "fileName": "contrato.pdf", "contentBase64": "JVBERi0xLjcK..." },
"recipients": [
{ "name": "Fulana de Exemplo", "email": "fulana@example.com", "signOrder": 1 },
{ "name": "Beltrano de Exemplo", "email": "beltrano@example.com", "signOrder": 2,
"qualification": "testemunha" }
],
"fields": [
{ "recipientEmail": "fulana@example.com", "type": "SIGNATURE",
"page": 1, "x": 0.1, "y": 0.8, "width": 0.3, "height": 0.06 },
{ "recipientEmail": "fulana@example.com", "type": "TEXT", "label": "CPF",
"format": "CPF", "page": 1, "x": 0.1, "y": 0.7, "width": 0.3, "height": 0.04 }
],
"send": true,
"acceptPermittedUsesVersion": "VERSAO_LIDA_EM_PERMITTED_USES"
}'GET/envelopes
Lista os documentos. Filtros na query: q (busca), status, externalId, folderId (ou none), limit (padrão 25, máximo 100) e cursor. Resposta: { items, nextCursor, total, counts }; passe nextCursor como cursor para a página seguinte.
curl "https://signexo.com.br/api/v1/envelopes?status=SENT&limit=50" \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"GET/envelopes/:id
Devolve um documento, com a situação de cada pessoa.
curl https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"PATCH/envelopes/:id
Altera um rascunho. Aceita, todos opcionais: title, message, signingOrder, deadlineDays, reminderIntervalDays e redirectUrl.
curl -X PATCH https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-d '{ "deadlineDays": 10 }'POST/envelopes/:id/document
Envia o PDF de um rascunho. O corpo são os bytes do arquivo, com Content-Type: application/pdf e o nome em X-File-Name (codificado como em URL). Até 20 MB.
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/document \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/pdf" \
-H "X-File-Name: contrato.pdf" \
--data-binary @contrato.pdfPessoas e campos
PUT/envelopes/:id/recipients
Substitui a lista de pessoas do rascunho. O corpo é uma lista; cada item tem name, email, role (SIGNER, padrão; CC para quem só recebe cópia; ou OBSERVER para quem acompanha sem assinar, com aviso por e-mail no envio, a cada assinatura, recusa ou cancelamento, e o PDF final), signOrder (a partir de 1), qualification (em que condição assina, até 60 caracteres) e delivery (EMAIL, padrão, ou NONE). E-mails não se repetem e é preciso ao menos um signatário.
curl -X PUT https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/recipients \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-d '[
{ "name": "Fulana de Exemplo", "email": "fulana@example.com", "signOrder": 1 },
{ "name": "Financeiro Exemplo", "email": "financeiro@example.com", "role": "CC" }
]'PUT/envelopes/:id/fields
Substitui os campos do rascunho (o PDF precisa já ter sido enviado). Cada item tem recipientEmail, type (SIGNATURE, INITIALS, DATE, NAME, TEXT ou CHECKBOX), page (a partir de 1), required (padrão true) e label.
- A posição (
x,y,width,height) é uma fração da página, de 0 a 1, com origem no canto superior esquerdo. O campo precisa caber inteiro na página. - Em campo
TEXT,formataplica máscara e validação:CPF,CNPJ,PHONE,DATEouEMAIL. DATEeNAMEsão preenchidos pelo sistema no momento da assinatura.- Signatário sem campo de assinatura posicionado não impede o envio: a assinatura dele vai para uma página de assinaturas, ao final do PDF.
curl -X PUT https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/fields \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-d '[
{ "recipientEmail": "fulana@example.com", "type": "SIGNATURE",
"page": 1, "x": 0.1, "y": 0.8, "width": 0.3, "height": 0.06 }
]'Envio e acompanhamento
GET/legal/permitted-uses
Devolve { version, title, body }: o texto de usos permitidos que quem envia confirma. A version lida vai no envio.
curl https://signexo.com.br/api/v1/legal/permitted-uses \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"POST/envelopes/:id/send
Envia o rascunho. Corpo: { "acceptPermittedUsesVersion": "..." }. Resposta: { envelope, emailFailures }, em que emailFailures é o número de convites que não puderam ser entregues ao serviço de e-mail. Aceita Idempotency-Key.
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/send \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-0001-envio" \
-d '{ "acceptPermittedUsesVersion": "VERSAO_LIDA_EM_PERMITTED_USES" }'POST/envelopes/:id/recipients/:recipientId/resend
Reenvia o convite por e-mail a quem está com a vez de assinar. Resposta: { emailSent }.
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/recipients/ID_DA_PESSOA/resend \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"PATCH/envelopes/:id/recipients/:recipientId
Corrige name, email ou phone de quem assina num documento SENT, enquanto a pessoa ainda não assinou nem recusou. Mande só o que muda; "phone": null tira o celular. O link anterior deixa de valer e, se for a vez da pessoa, o convite vai ao endereço novo (com delivery: "NONE", peça o link novo pela rota de link). Resposta: { envelope, fields, linkReissued, inviteSent }. Erros 409: not_sent, expired, not_signer, already_signed, email_in_use.
curl -X PATCH https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/recipients/ID_DA_PESSOA \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-d '{ "email": "fulana.certa@example.com" }'POST/envelopes/:id/void
Cancela um documento enviado. Corpo: { "reason": "..." } (3 a 500 caracteres).
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/void \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-H "Content-Type: application/json" \
-d '{ "reason": "Contrato substituído por nova versão" }'POST/envelopes/:id/complete
Gera o PDF final quando todas as pessoas já assinaram e a geração automática falhou (allSigned: true com status: "SENT"). Se ainda falta assinatura, 409 not_all_signed.
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/complete \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"GET/envelopes/:id/events
Histórico do documento: { events: [...] }, cada um com sequence, type, actorType, recipientId, occurredAt e metadata.
curl https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/events \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"Link de assinatura sem e-mail
Com delivery: "NONE", o SigNexo não envia o convite àquela pessoa: o seu sistema pede o link e o entrega como preferir (ou o abre em iframe). O código de confirmação continua indo para o e-mail da pessoa: o link sozinho não assina.
POST/envelopes/:id/recipients/:recipientId/link
Resposta: { recipientId, url, expiresAt }. Cada chamada emite um link novo e invalida o anterior. Só vale para quem está com a vez de assinar (409 not_notified fora disso) e tem delivery: "NONE" (409 delivery_email para os demais).
curl -X POST https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/recipients/ID_DA_PESSOA/link \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA"O link é pessoal e dá acesso à página de assinatura: trate-o como segredo e não o grave em log.
Arquivos
GET/envelopes/:id/document
Baixa o PDF original, como foi enviado.
GET/envelopes/:id/final
Baixa o PDF final, com as assinaturas e as evidências. Só existe depois da conclusão; antes disso, 404 not_found.
curl https://signexo.com.br/api/v1/envelopes/ID_DO_DOCUMENTO/final \
-H "Authorization: Bearer sgx_test_CHAVE_DE_EXEMPLO_NAO_FUNCIONA" \
-o contrato-assinado.pdfO documento traz document.sha256 (original) e document.signedSha256 (final). Qualquer pessoa pode conferir um arquivo em Verificar documento.
Webhooks
Em vez de consultar a API de tempos em tempos, cadastre um endereço https no painel, em Integrações › Webhooks, e escolha os eventos (nenhum selecionado = todos). O segredo do destino (whsec_…) aparece uma única vez, na criação.
| Evento | Quando é enviado |
|---|---|
envelope.sent | O documento foi enviado. |
recipient.notified | Chegou a vez de uma pessoa assinar. |
recipient.viewed | A pessoa abriu o link pela primeira vez. |
recipient.signed | A pessoa assinou. |
recipient.declined | A pessoa recusou; o documento é encerrado. |
envelope.completed | PDF final gerado. Traz signedSha256 e originalSha256. |
envelope.voided | Documento cancelado. Traz reason. |
envelope.expired | O prazo venceu. Traz expiresAt. |
email.failed | Um e-mail não pôde ser entregue. Traz emailKind e failureReason. |
recipient.corrected | Quem enviou corrigiu nome, e-mail ou celular de quem assina. Traz fields (o que mudou). Sem dado pessoal: data.recipient leva só o id; consulte o documento para ver os dados novos. |
O corpo é JSON. data.recipient é nulo nos eventos que não dizem respeito a uma pessoa, e os dados próprios do evento ficam ao lado de envelope e recipient, dentro de data. O botão de teste do painel envia um evento ping, com data vazio.
{
"id": "evt_0123456789abcdef01234567",
"type": "recipient.signed",
"createdAt": "2026-01-15T14:03:22.000Z",
"data": {
"envelope": {
"id": "ID_DO_DOCUMENTO",
"title": "Contrato de exemplo",
"status": "SENT",
"externalId": "pedido-0001",
"metadata": { "origem": "loja-exemplo" },
"verificationCode": "CODIGO-DE-EXEMPLO"
},
"recipient": {
"id": "ID_DA_PESSOA",
"name": "Fulana de Exemplo",
"email": "fulana@example.com",
"role": "SIGNER",
"status": "SIGNED"
}
}
}| Cabeçalho | Conteúdo |
|---|---|
Signexo-Event-Id | O id do evento, igual em todas as tentativas. |
Signexo-Event-Type | O tipo do evento. |
Signexo-Signature | t=<unix>,v1=<hmac>: assinatura do corpo. |
User-Agent | Signexo-Webhooks/1 |
Conferir a assinatura
v1 é o HMAC-SHA256, em hexadecimal, de <t>.<corpo>, usando o segredo do destino como chave. Calcule sobre o corpo exatamente como chegou, compare em tempo constante e recuse mensagens com mais de 5 minutos de diferença de relógio.
import { createHmac, timingSafeEqual } from "node:crypto";
// rawBody: o corpo exatamente como chegou (texto), antes de JSON.parse.
// header: o valor de Signexo-Signature. secret: o whsec_... do destino.
export function isFromSignexo(rawBody, header, secret) {
const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const timestamp = Number(parts.t);
if (!Number.isInteger(timestamp) || !parts.v1) return false;
// Recusa mensagem com mais de 5 minutos de diferença de relógio.
if (Math.abs(Date.now() / 1000 - timestamp) > 300) return false;
const expected = createHmac("sha256", secret)
.update(`${timestamp}.${rawBody}`)
.digest();
const given = Buffer.from(parts.v1, "hex");
return expected.length === given.length && timingSafeEqual(expected, given);
}Entrega e reenvio
- Responda com um código 2xx em até 10 segundos. Qualquer outra resposta, inclusive redirecionamento, conta como falha.
- Depois de uma falha, novas tentativas acontecem após 1 minuto, 5 minutos, 30 minutos, 2 horas, 6 horas e 12 horas. Sem sucesso até a última, ou passadas 24 horas da criação do evento, a entrega é marcada como falha.
- O mesmo evento pode chegar mais de uma vez: use
Signexo-Event-Idpara ignorar repetições. A ordem de chegada não é garantida. - O painel mostra as últimas entregas de cada destino e permite reenviar uma delas.
Assinatura embutida
A página de assinatura pode ser aberta em um iframe dentro do seu site. Por padrão ela recusa ser embutida; para liberar, cadastre a origem do seu site (por exemplo https://app.example.com, só https e sem caminho) em Integrações › Assinatura embutida. Use como endereço do iframe a url devolvida pela rota de link.
A página avisa a sua com window.postMessage. Toda mensagem tem source: "signexo" e um type; nenhuma leva nome, e-mail, CPF ou o link de assinatura.
| Mensagem | Significado |
|---|---|
signexo:loaded | A pessoa confirmou o código e o documento está na tela. |
signexo:signed | Assinatura registrada. completed diz se o PDF final já foi gerado. |
signexo:declined | A pessoa recusou assinar. |
signexo:error | O link não pode ser usado (code: "link_unavailable"). |
<iframe id="assinatura" src="URL_DE_ASSINATURA"
title="Assinar documento" style="width:100%;height:720px;border:0"></iframe>
<script>
window.addEventListener("message", (event) => {
// A origem é a do endereço de assinatura que você recebeu da API.
if (event.origin !== new URL("URL_DE_ASSINATURA").origin) return;
if (!event.data || event.data.source !== "signexo") return;
switch (event.data.type) {
case "signexo:loaded": /* documento na tela */ break;
case "signexo:signed": /* event.data.completed: true ou false */ break;
case "signexo:declined": /* a pessoa recusou */ break;
case "signexo:error": /* link indisponível */ break;
}
});
</script>- Confira sempre
event.originantes de confiar na mensagem. - As mensagens servem para atualizar a sua tela. Para registrar a assinatura no seu sistema, confie no webhook ou consulte o documento pela API.
Agentes de IA (MCP)
Um assistente de IA compatível com o Model Context Protocol (MCP) pode preparar, enviar e acompanhar documentos em nome da sua organização. O servidor fica em https://signexo.com.br/api/mcp (Streamable HTTP, sem sessão). Há dois jeitos de conectar: pelo login no SigNexo, sem chave (claude.ai, Claude Desktop, ChatGPT), ou com a chave da API no cabeçalho (Claude Code e clientes que aceitam cabeçalho fixo).
Pelo login: claude.ai, Claude Desktop e ChatGPT
Esses assistentes conectam por OAuth: você entra no SigNexo, escolhe a organização e permite o acesso. Nenhuma chave é copiada. O nome dos menus muda de tempos em tempos; procure por “conector personalizado” ou “conector”.
- claude.ai e Claude Desktop: em Configurações › Conectores, escolha “Adicionar conector personalizado”, dê um nome (por exemplo, SigNexo) e cole
https://signexo.com.br/api/mcp. Clique em Conectar. O conector vale para as duas pontas, porque fica na sua conta. Em planos de equipe, quem administra a conta do Claude pode precisar adicioná-lo antes. - ChatGPT: nas configurações de aplicativos e conectores, crie um conector com a URL
https://signexo.com.br/api/mcpe autenticação OAuth. Pode ser preciso ligar o modo de desenvolvedor da conta. - Abre-se a tela do SigNexo. Entre com o link que chega no seu e-mail, confira o nome do aplicativo e o endereço de retorno (por exemplo,
claude.aiouchatgpt.com), escolha a organização e clique em Permitir. - O assistente age como você, com o seu papel na organização. Só quem pode criar e enviar documentos consegue permitir. Se você sair da organização ou passar a só ler, o acesso para de valer.
- Para desconectar, use Aplicativos conectados no painel: cada pessoa vê e desconecta o que conectou, e quem administra vê os de toda a organização. O acesso cai na hora. A conexão vale até 90 dias; depois, o assistente pede para você permitir de novo.
Para quem implementa um cliente: o servidor segue a especificação de autorização do MCP (2025-11-25). Sem credencial, /api/mcp responde 401 com WWW-Authenticate apontando /.well-known/oauth-protected-resource/api/mcp; os metadados do servidor de autorização ficam em /.well-known/oauth-authorization-server. Há registro dinâmico de cliente e Client ID Metadata Documents, PKCE S256 obrigatório, o parâmetro resource e o escopo documents. O token de acesso vale 1 hora; o de renovação, 30 dias, e muda a cada uso.
Com chave no cabeçalho: Claude Code e outros
Crie uma chave em Integrações › Chaves de API e envie no cabeçalho Authorization: Bearer. Nos exemplos, sgx_live_SUA_CHAVE é só um marcador: troque pela sua chave.
claude mcp add --transport http signexo https://signexo.com.br/api/mcp --header "Authorization: Bearer sgx_live_SUA_CHAVE"Em outros clientes, a configuração costuma ter o endereço e os cabeçalhos. O nome dos campos pode variar; confira a documentação do seu cliente.
{
"mcpServers": {
"signexo": {
"url": "https://signexo.com.br/api/mcp",
"headers": {
"Authorization": "Bearer sgx_live_SUA_CHAVE"
}
}
}
}send_document faz os convites saírem e void_document encerra os links e avisa as pessoas. Configure o seu cliente para pedir a sua confirmação antes dessas duas ferramentas, e confira o documento (get_document) antes de enviar.
Ferramentas
| Ferramenta | O que faz |
|---|---|
who_am_i | Em nome de qual organização e pessoa o agente age, e se é teste ou produção. |
get_permitted_uses | Texto de usos permitidos que quem envia aceita, com a versão. |
list_documents | Lista os documentos, com filtro por situação e busca. |
get_document | Situação, arquivos, pessoas, campos e o que falta para enviar. |
get_document_history | Trilha de auditoria do documento, em ordem. |
create_document | Cria um rascunho, já com PDF, pessoas e campos se quiser. Não envia. |
update_document | Altera título, mensagem, ordem, prazo ou lembretes de um rascunho. |
add_pdf | Anexa um PDF ao rascunho (até 5 arquivos, 25 MB no total). |
set_recipients | Define quem assina, quem recebe cópia e quem acompanha. |
set_fields | Define os campos de cada pessoa, por âncora no texto ou por posição. |
send_document | Envia o rascunho: os convites saem. Não se desfaz. |
void_document | Cancela um documento enviado e avisa as pessoas. Não se desfaz. |
resend_invite | Reenvia o convite a quem está com a vez, com link novo. |
replace_signer | Corrige nome, e-mail ou celular de quem ainda não assinou; o link antigo cai. |
get_signing_link | Gera o link de quem recebe pela integração (sem e-mail de convite). |
complete_document | Gera o PDF final quando todos assinaram e a geração automática falhou. |
get_final_pdf | Devolve o PDF final, com a página de evidências. |
list_templates | Lista os modelos da organização. |
get_template | Mostra os papéis e as variáveis de um modelo. |
create_from_template | Cria um rascunho a partir de um modelo. Não envia. |
A chave dá ao agente o mesmo acesso que ela dá à API, em nome da organização que a criou. Guarde-a como uma senha e revogue em Integrações se ela vazar. Pelo login, o acesso é o da pessoa que permitiu, na organização que ela escolheu.