Leases
Signatures
Cancel a signature request
Cancels an ongoing signature request and resets the lease to DRAFT status. This operation allows re-initiating a signature after cancellation.
Action performed
This operation performs the following steps:
- Marks the document as CANCELLED in DO Global (signature orchestrator)
- Marks all signers as CANCELLED in DO Global
- Marks the document as FAILED in the database (allows re-initiation)
- Marks all ongoing signature requests as FAILED (Pending, OtpSent, Signing)
- Resets the lease to DRAFT status
Re-initiation possible
After a cancellation, you can re-initiate a new signature via POST /leases/{lease_id}/signature/initiate. The system detects that the previous document is in FAILED status and allows re-initiation.
Difference with reset
Unlike DELETE /leases/{lease_id}/signature/reset, this operation:
- Preserves history: Documents and signature requests remain in the database with FAILED status
- Marks as failed: The status is changed to FAILED in the DB (and CANCELLED in DO Global)
- Allows auditing: Previous attempts remain visible for traceability
- Allows re-initiation: A new signature process can be initiated immediately
Use cases
Use this operation when:
- You have detected an error in the contract before sending
- You want to correct the document and re-initiate
- You need to preserve the history of attempts
- The tenant is not responding and you want to re-initiate after correction
Prerequisites
- The lease must be in PENDING_SIGNATURE status
- A signature document must exist
- The user must have the leases:write permission
delete/leases/{lease_id}/signature/cancel
Request
- Base URL: https://api.faireplace.com/api
- URL: https://api.faireplace.com/api/leases/{lease_id}/signature/cancel
- Auth: HTTP bearer
Path parameters
lease_idstring uuid required
Lease ID
Response
Signature cancelled successfully
Example response
{
"success": true,
"message": "Signature cancelled for lease 550e8400-e29b-41d4-a716-446655440001",
"document_signature_id": "550e8400-e29b-41d4-a716-446655440000"
}Changes
No recorded changes to this operation across all 1 revision of this API.