SigningSessions

Cancelar sessão de assinatura

Cancela uma sessão de assinatura ativa. Apenas sessões com status ACTIVE podem ser canceladas. O cancelamento cascateia para a transação subjacente.

Requer scope transactions:write.

post/v1/signing-sessions/{sessionId}/cancel

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/signing-sessions/{sessionId}/cancel
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

Identificador único da sessão de assinatura.

Response

Sessão cancelada com sucesso.

sessionIdstring required
transactionIdstring required
status'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' | 'FAILED' required

Status da sessão de assinatura.

cancelledAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.