Cancelar Documento

Cancela um envelope que ainda nao foi completamente assinado. Todos os signatarios pendentes serao notificados sobre o cancelamento.

Requisicao

POST /v1/envelopes/{id}/cancel

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao

Parametros de URL

Parametro	Tipo	Obrigatorio	Descricao
id	string	Sim	Identificador unico do envelope

Body

Nenhum body necessario.

Exemplo de requisicao

curl -X POST \
  https://api.tapsign.com.br/v1/envelopes/env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a/cancel \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "id": "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
  "name": "Contrato de Prestacao de Servicos - Carlos Mendes",
  "status": "CANCELED",
  "canceledAt": "2026-03-29T16:00:00Z",
  "canceledBy": "Maria Silva",
  "signers": [
    {
      "id": "sgn_aaa111bbb",
      "name": "Carlos Eduardo Mendes",
      "email": "carlos@email.com",
      "status": "SIGNED",
      "signedAt": "2026-03-26T15:42:00Z"
    },
    {
      "id": "sgn_ccc333ddd",
      "name": "Ana Paula Costa",
      "email": "ana@empresa.com.br",
      "status": "CANCELED",
      "signedAt": null
    }
  ]
}

Campos da resposta

Campo	Tipo	Descricao
id	string	Identificador unico do envelope
name	string	Nome do envelope
status	string	Status atualizado para CANCELED
canceledAt	string	Data/hora do cancelamento (ISO 8601)
canceledBy	string	Nome do usuario que cancelou o envelope
signers[].id	string	Identificador do signatario
signers[].name	string	Nome do signatario
signers[].email	string	Email do signatario
signers[].status	string	Status final do signatario
signers[].signedAt	string	Data da assinatura (se ja havia assinado)

Atencao

O cancelamento so e possivel enquanto o envelope nao foi completamente assinado. Se todos os signatarios ja assinaram (status COMPLETED), o envelope nao pode ser cancelado.

401 - Nao autorizado

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

404 - Nao encontrado

{
  "error": "NOT_FOUND",
  "message": "Envelope nao encontrado ou nao pertence a sua organizacao."
}

422 - Estado invalido

{
  "error": "UNPROCESSABLE_ENTITY",
  "message": "O envelope ja foi concluido e nao pode ser cancelado."
}

Acao irreversivel

O cancelamento e permanente. Um envelope cancelado nao pode ser reativado. Caso precise, crie um novo envelope com os mesmos documentos e signatarios.