Pular para o conteúdo principal

Recusar Documento

Registra a recusa de um signatário em assinar o documento.

Este é um endpoint público: não requer autenticação. O token na URL (o accessToken do signatário) identifica quem está recusando.

Endpoint​

POST /v1/signing/{token}/decline
Endpoint público

Este endpoint não exige o header Authorization. O token na URL já identifica o signatário. Por isso, trate o accessToken como segredo.

Parâmetros de URL​

ParâmetroTipoObrigatórioDescrição
tokenstring (UUID)SimaccessToken do signatário

Body​

CampoTipoObrigatórioDescrição
reasonstringSimMotivo da recusa, com até 500 caracteres

Exemplo de Requisição​

curl -X POST https://api.tapsign.com.br/v1/signing/3f6c2a9e-8b1d-4c7a-9e2f-5d4b8a1c0e77/decline \
-H "Content-Type: application/json" \
-d '{
"reason": "Os termos do contrato não estão de acordo com o combinado."
}'

Resposta de Sucesso​

Status: 200 OK

{
"message": "Assinatura recusada com sucesso"
}

O que acontece após a recusa​

  • O signatário passa para o status DECLINED, com declinedAt e declineReason preenchidos. Consulte em Detalhar Documento.
  • O evento DECLINED é gravado no histórico de atividades.
  • O webhook doc_refused é disparado com o motivo no campo rejected_reason. Veja Eventos de Webhook.
  • O status do envelope não muda. Ele continua SENT ou IN_PROGRESS e não chega a COMPLETED, porque a conclusão exige que todos os signatários assinem. Os demais signatários ainda conseguem assinar. Para encerrar o fluxo, cancele o envelope.

Quem pode recusar​

Somente signatários com status NOTIFIED ou VIEWED, ou seja, depois que o envelope foi enviado. Quem já assinou ou já recusou recebe erro.

Erros​

CódigoQuando acontece
400reason ausente ou com mais de 500 caracteres. A resposta traz o motivo em fields
400O status do signatário não permite recusa (por exemplo, já assinou ou já recusou)
400O envelope passou da data de expiração (expiresAt)
404O token não corresponde a nenhum signatário

O formato do corpo de erro está em Status de Erros.

Ação irreversível

A API não oferece forma de desfazer uma recusa.