Excluir Documento

A exclusão de envelopes acontece em duas etapas: primeiro o envelope vai para a lixeira e depois pode ser excluído de forma definitiva. Enquanto estiver na lixeira, ele pode ser restaurado.

Todas as rotas em lote recebem uma lista de IDs e respondem com a quantidade de envelopes afetados. IDs que não existem ou que não são da sua conta são ignorados e não entram na contagem.

Etapa 1: Mover para a Lixeira

Requisição

POST /v1/envelopes/trash

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {token}
Content-Type	string	Sim	application/json

Body (JSON)

Campo	Tipo	Obrigatório	Descrição
ids	number[]	Sim	IDs dos envelopes a mover para a lixeira

Exemplo de requisição

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/trash \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [512, 513]
  }'

Resposta

200 - Sucesso

{
  "affected": 2
}

Campo	Tipo	Descrição
affected	number	Quantidade de envelopes movidos para a lixeira

Lixeira não cancela o envelope

Mover para a lixeira só tira o envelope da listagem (GET /v1/envelopes). O status não muda. Para interromper as assinaturas de um envelope enviado, cancele o envelope antes.

---

Listar a Lixeira

GET /v1/envelopes/trash?page=0&size=10

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
page	number	Não	0	Número da página (começa em 0)
size	number	Não	10	Itens por página

curl -X GET \
  "https://api.tapsign.com.br/v1/envelopes/trash?page=0&size=10" \
  -H "Authorization: Bearer {token}"

A resposta é uma página com os envelopes da lixeira, dos movidos mais recentemente para os mais antigos. Cada item de content tem os mesmos campos da resposta de criar envelope.

---

Restaurar da Lixeira

POST /v1/envelopes/restore

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/restore \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [512]
  }'

200 - Sucesso

{
  "affected": 1
}

---

Etapa 2: Excluir Permanentemente

Requisição

POST /v1/envelopes/permanently-delete

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {token}
Content-Type	string	Sim	application/json

Body (JSON)

Campo	Tipo	Obrigatório	Descrição
ids	number[]	Sim	IDs dos envelopes a excluir. Todos precisam estar na lixeira

Exemplo de requisição

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/permanently-delete \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [512, 513]
  }'

Resposta

200 - Sucesso

{
  "affected": 2
}

Erros

Código	Quando acontece
400	Algum dos envelopes informados não está na lixeira. Nesse caso nenhum envelope da requisição é excluído
401	Token ausente ou inválido

Exemplo de erro 400 (com Accept-Language: pt-BR):

{
  "title": "Violação de regra de negócio!",
  "status": 400,
  "details": "O documento precisa estar na lixeira para ser excluído permanentemente.",
  "timestamp": "2026-09-12T16:10:00Z",
  "fields": {}
}

Ação irreversível

A exclusão permanente não pode ser desfeita. Depois dela, o envelope não pode mais ser restaurado.

Cota do plano

Nem a lixeira nem a exclusão permanente devolvem a cota mensal de documentos do plano, que é descontada na criação do envelope.

---

Excluir um documento em rascunho

Para apagar o arquivo enviado em POST /v1/documents que não chegou a ser usado:

DELETE /v1/documents/{id}

curl -X DELETE \
  https://api.tapsign.com.br/v1/documents/1024 \
  -H "Authorization: Bearer {token}"

204 - Sucesso (No Content)

O documento e o arquivo armazenado são removidos. Nenhum corpo de resposta é retornado.

Erros

Código	Quando acontece
400	O documento não está DRAFT, ou tem envelope ativo (DRAFT, SENT ou IN_PROGRESS)
401	Token ausente ou inválido
404	O documento não existe ou não é da sua conta