For the complete documentation index, see llms.txt. You can also append .md to any page URL to get its markdown version.
Skip to main content
For the complete documentation index, see llms.txt.

For the complete documentation index, see llms.txt

Reject a signing order

End-users have the option to reject a signing session instead of completing or cancelling it. When rejecting, the user can provide a specific reason for the rejection, which allows you to understand why the document was not signed and take appropriate action. The Signicat Dashboard allows you to monitor and review rejections.

End-user experience​

In the signing interface, the end-user can access the More actions dropdown menu and select Reject signing to reject the signing.

The dropdown menu in the signing interface showing options for Download, Cancel and Reject signing.

When they choose to reject, a popup appears allowing them to specify a reason for the rejection (up to 2048 characters). Providing a reason is optional.

The popup modal titled 'Reject signing' with a text box for the user to enter a reason.

Once rejected, the signing session is permanently terminated. A rejected session is final and the user cannot return to it later to sign the document.

How it works​

Configure a rejection redirect​

By default, if an end-user rejects a signing session, they are redirected to a standard rejection page hosted by Signicat.

The default screen showing the message 'The signature has been rejected' and 'Feel free to close this window'.

You can override the default by specifying a custom reject URL in the redirectSettings object in your HTTP POST request to the Signing sessions endpoint when you create the signing session:

{
  "redirectSettings": {
    "success": "https://www.example.com/success",
    "cancel": "https://www.example.com/cancel",
    "error": "https://www.example.com/error",
    "reject": "https://www.example.com/reject"
  }
}
Note

Including reject in redirectSettings is optional. You can also update the redirect URL later by making an HTTP PATCH request to the Signing sessions endpoint.

Handle rejection responses​

When a signing session is rejected, the session's state changes to REJECTED.

If you retrieve the session details using an HTTP GET request to the Signing sessions endpoint, the lifecycle object will reflect this state.

Additionally, if the user provided a reason, a new rejectReason field will be included in the lifecycle object.

{
  "lifecycle": {
    "state": "REJECTED",
    "stateIsFinal": true,
    "rejectReason": "The contract terms were incorrect."
  }
}

Dashboard and webhooks​

Rejections are integrated into the Signicat Dashboard and event system:

Events​

A rejection generates an event. In the Events section of the Dashboard, you can configure webhooks to listen for this events, which allows your backend systems to react when a user rejects a document.

The Events view in the Signicat Dashboard, showing details of a 'Signing session rejected' event.

Signicat Dashboard​

In the Electronic Signature API section of the Dashboard, you can view all your signing sessions. When inspecting a rejected session, you can see the session details, including the specific rejectReason provided by the user.

The Sessions list in the Signicat Dashboard, where rejected sessions are shown with a red 'Rejected' status.

On this page