Cancelar Documento

Cancela um envelope que ainda não foi concluído. O envelope passa para CANCELED, o evento entra no histórico e o webhook doc_canceled é disparado.

Requisição

POST /v1/envelopes/{id}/cancel

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {token}

Parâmetros de URL

Parâmetro	Tipo	Obrigatório	Descrição
id	number	Sim	Identificador do envelope

Body

Nenhum body necessário.

Exemplo de requisição

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/512/cancel \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "message": "Envelope cancelado com sucesso"
}

Status permitidos

O cancelamento é aceito para envelopes com status DRAFT, SENT ou IN_PROGRESS. Envelopes COMPLETED, CANCELED ou EXPIRED não podem ser cancelados.

Notificações

O cancelamento dispara o webhook doc_canceled para os webhooks inscritos nesse evento. Esta rota não envia e-mail aos signatários.

Erros

Código	Quando acontece
400	O envelope está COMPLETED, CANCELED ou EXPIRED
401	Token ausente ou inválido
404	O envelope não existe ou não é da sua conta

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

{
  "title": "Violação de regra de negócio!",
  "status": 400,
  "details": "Envelope não pode ser cancelado no status atual: COMPLETED",
  "timestamp": "2026-09-12T16:00:00Z",
  "fields": {}
}

---

Cancelar pelo token do documento

Se a sua integração guarda o token do documento (devolvido por Criar Documento via Modelo e enviado no campo token dos webhooks), cancele por ele:

DELETE /v1/integration/documents/{token}

curl -X DELETE \
  https://api.tapsign.com.br/v1/integration/documents/9f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f \
  -H "Authorization: Bearer {token}"

200 - Sucesso

{
  "message": "Documento cancelado com sucesso"
}

As regras são as mesmas do cancelamento pelo id: mesmos status permitidos, mesmo webhook doc_canceled.

Erros

Código	Quando acontece
400	O envelope está COMPLETED, CANCELED ou EXPIRED
401	Token de autenticação ausente ou inválido
404	Nenhum envelope com esse token, ou o envelope não é da sua conta

Ação irreversível

Não há rota para reativar um envelope cancelado. Se precisar, crie um novo envelope com o mesmo documento e os mesmos signatários.