▲ Top

Signing Ceremony Settings

This section: (1) describes various Signing Ceremony Settings that can be configured for a package via the REST API; (2) provides a JSON Example of how to do so.

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

The following Signing Ceremony parameters can be configured for a package via the REST API.

inPerson (boolean) Flag that determines if: (1) all documents in the package must be signed by the package owner; (2) all signers must sign on the same device
declineButton (boolean) Flag that determines if a signer can decline to sign the package
declineReasons (array[string]) Enables a signer who just declined to sign to provide a reason for doing so
disableDeclineOther (boolean) Setting this flag to true disables the Other option when a signer is prompted to provide a reason for declining to sign.
disableDownloadForUncompletedPackage (boolean) Setting this flag to true disables the Download button for incomplete packages
disableFirstInPersonAffidavit (boolean)

Setting this flag to true disables the first Affidavit page when In Person signing is used.

The parameter disableInPersonAffidavit takes precedence over this flag.

disableInPersonAffidavit (boolean) Setting this flag to true disables both Affidavit pages when In Person signing is used.
disableSecondInPersonAffidavit (boolean)

Setting this flag to true disables the second Affidavit page when In Person signing is used.

The parameter disableInPersonAffidavit takes precedence over this flag.

handOver (Link,optional) If a PACKAGE_OPT_OUT, PACKAGE_DECLINE, or SIGNER_COMPLETE event occurs, the signer will be redirected to this URL. It contains the original URL plus additional query parameters.
hideCaptureText (boolean) Flag that determines if signed documents will be stamped at each signature location with the date, time, and signer's name
hideLanguageDropdown (boolean) Flag that determines if the Language drop-down menu will appear on the Signing Ceremony page
hidePackageOwnerInPerson (boolean) When this flag is set to true, the package owner will not be shown in the In Person Signing drop-down menu.
hideWatermark (boolean) Flag that determines if all signatures in signed documents are stamped with the OneSpan Sign logo
maxAuthFailsAllowed (integer,optional) Maximum number of times a signer can attempt to be authenticated before the system locks them out
optOutButton (boolean) Flag that determines if a signer can opt out of electronically signing the package
optOutReasons (array[string]) Enables a signer who just opted out of electronic signing to provide a reason for doing so
disableOptOutOthe r(boolean) Setting this flag to true disables the Other option when a signer is prompted to provide a reason for opting out of electronic signing.
ada (boolean) Setting this flag to true makes all created packages accessible. For REST API details, see Create an Accessible Package.

JSON Example

The following simple code sample illustrates how to use the REST API to configure Signing Ceremony parameters for a document package.

The following code is not a valid JSON request, since it's merely an excerpt from the code for a document package.

{
   "settings":{
      "ceremony":{
         "inPerson":true,
         "disableFirstInPersonAffidavit":false,
         "disableInPersonAffidavit":false,
         "disableSecondInPersonAffidavit":false,
         "disableDownloadForUncompletedPackage":false,
         "handOver":null,
         "hideCaptureText":false,
         "hideLanguageDropdown":false,
         "hideWatermark":false,
         "hidePackageOwnerInPerson":false,
         "maxAuthFailsAllowed":3,
         "declineButton":true,
         "disableDeclineOther":false,
         "declineReasons":[
            "Reason 1",
            "Reason 2",
            "No Reason"    
         "optOutButton":true,
         "disableOptOutOther":true
         "optOutReasons":[
            "Reason 1",
            "Reason 2"
         ]
      }
   }
}