Excluir Documento

Exclui envelopes em duas etapas: primeiro move para a lixeira (trash) e depois exclui permanentemente. Isso evita exclusoes acidentais.

Etapa 1: Mover para a Lixeira

Requisicao

POST /v1/envelopes/trash

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao
Content-Type	string	Sim	application/json

Body (JSON)

Campo	Tipo	Obrigatorio	Descricao
envelopeIds	array	Sim	Lista de IDs dos envelopes a mover

Exemplo de requisicao

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/trash \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "envelopeIds": [
      "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "env_a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
    ]
  }'

Resposta

204 - Sucesso (No Content)

A requisicao foi processada com sucesso. Nenhum corpo de resposta e retornado.

---

Etapa 2: Excluir Permanentemente

Requisicao

POST /v1/envelopes/permanently-delete

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao
Content-Type	string	Sim	application/json

Body (JSON)

Campo	Tipo	Obrigatorio	Descricao
envelopeIds	array	Sim	Lista de IDs dos envelopes na lixeira para excluir

Exemplo de requisicao

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/permanently-delete \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "envelopeIds": [
      "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "env_a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
    ]
  }'

Resposta

204 - Sucesso (No Content)

A requisicao foi processada com sucesso. Os envelopes foram excluidos permanentemente.

---

Erros comuns

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou expirado."
}

404 - Nao encontrado

{
  "error": "NOT_FOUND",
  "message": "Um ou mais envelopes nao foram encontrados."
}

422 - Estado invalido

{
  "error": "UNPROCESSABLE_ENTITY",
  "message": "Somente envelopes na lixeira podem ser excluidos permanentemente."
}

Acao irreversivel

A exclusao permanente nao pode ser desfeita. Todos os documentos, assinaturas e trilhas de auditoria serao removidos definitivamente.

Dica

Voce pode mover varios envelopes para a lixeira e excluir permanentemente em lote, enviando multiplos IDs no array envelopeIds.

Atencao

Envelopes com status IN_PROGRESS ou SENT devem ser cancelados antes de serem movidos para a lixeira. Somente envelopes com status DRAFT, COMPLETED, CANCELED ou EXPIRED podem ser movidos diretamente.