Informações Gerais

Bem-vindo à documentação da API do TapSign. Aqui você encontra o que precisa para integrar assinatura eletrônica ao seu sistema: enviar documentos, acompanhar assinaturas e receber eventos por webhook.

Visão Geral

A API do TapSign é uma API REST que recebe e devolve JSON. Uploads de arquivo usam multipart/form-data. Use sempre HTTPS.

Base URL

https://api.tapsign.com.br

As rotas começam com /v1, por exemplo https://api.tapsign.com.br/v1/envelopes. A API de compatibilidade para quem migra de outra plataforma usa o prefixo /api/v1 (veja Criar via Modelo).

Autenticação

As requisições autenticadas levam o header:

Authorization: Bearer {token}

Onde {token} é uma chave de API (começa com tsk_) ou um access token JWT obtido em /v1/auth/api/token. O acesso à API está disponível nos planos Equipe e Enterprise.

Consulte o guia de autenticação para os detalhes.

Convenções da API

Content-Type

Requisições com corpo usam Content-Type: application/json, exceto o upload de arquivos, que usa multipart/form-data.

Campos sem valor

Campos sem valor podem vir como null. Trate null e campo ausente da mesma forma e não compare com string vazia.

{
  "title": "Contrato de Prestação de Serviços",
  "message": null
}

Booleanos

Valores booleanos são true ou false nativos do JSON, nunca as strings "true" ou "false".

Datas e fuso horário

As datas das respostas estão em UTC, no formato ISO 8601 com precisão de segundos e sufixo Z:

{
  "createdAt": "2026-09-12T14:30:00Z",
  "sentAt": "2026-09-12T14:35:10Z"
}

Ao enviar datas (por exemplo expiresAt), use ISO 8601:

• Com fuso: 2026-09-30T18:00:00-03:00 é convertido para UTC (21:00:00Z)
• Sem fuso: 2026-09-30T21:00:00 é tratado como UTC

Fuso horário do Brasil

Para exibir no horário de Brasília (UTC-03:00), subtraia 3 horas: 14:30:00Z corresponde a 11:30:00. Filtros que recebem só a data (como dateFrom e dateTo na listagem de documentos) consideram o dia no calendário de Brasília.

IDs

• Envelopes, documentos, signatários, campos, webhooks e chaves de API usam IDs numéricos inteiros:

  { "id": 1234 }

• Modelos e tokens usam UUID em texto: o ID do modelo (templateId), o token do envelope na API de integração e nos webhooks, e o token de acesso do signatário usado no link de assinatura.

Paginação

Listagens paginadas recebem page (começa em 0) e size na query string. O tamanho padrão varia por rota e está em cada página.

GET /v1/envelopes?page=0&size=20

A resposta segue o formato de página do Spring:

{
  "content": [],
  "totalElements": 150,
  "totalPages": 8,
  "size": 20,
  "number": 0
}

Campo	Descrição
content	Itens da página atual
totalElements	Total de itens encontrados
totalPages	Total de páginas
size	Tamanho da página
number	Página atual (começa em 0)

A resposta também traz campos auxiliares como first, last e empty.

Referência interativa (OpenAPI)

O ambiente de testes expõe a especificação OpenAPI com interface para explorar e testar as rotas:

• Swagger UI: sandbox-api.tapsign.com.br/swagger-ui/index.html
• Scalar: sandbox-api.tapsign.com.br/scalar

Em produção essas páginas ficam fechadas.

Links rápidos

Tópico	Descrição
Autenticação	Chaves de API e tokens JWT
Ambiente de Testes	Use o sandbox para testar sem riscos
Criar Documento	Envie um arquivo e crie o envelope
Criar via Modelo	Gere e envie um documento a partir de um modelo em uma chamada
Webhooks	Receba eventos em tempo real
Rate Limit	60 requisições por minuto por chave de API
Status de Erros	Códigos de erro e como tratá-los

Suporte

Canal	Contato
Central de Ajuda	API e webhooks
E-mail	[email protected]
Site	tapsign.com.br

Dica

Antes de entrar em contato, veja se sua dúvida já está no FAQ. Para problemas técnicos, informe o método e a rota chamados, o horário (em UTC) e o corpo da resposta de erro.

---

Próxima seção: Ambiente de Testes: configure o sandbox para testar sua integração.