To download the full code sample see our Code Share site.

The OneSpan Sign Signing Ceremony can be customized. By customizing the Signing Ceremony you can seamlessly integrate the signing process within your own site.

Document Package Settings

The following table provides a brief description of the Signing Ceremony settings that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Setting Name Document Package Settings Method Description
In-person withInPerson Defines whether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out Other withOptOutOther (default) Defines whether the package sender/owner can opt-out.
withoutOptOutOther
Opt-Out withOptOut (default) Allows a signer to not participate in the signing ceremony.
withoutOptOut
Opt-Out Reason withOptOutReason If a signer decides to opt-out, allows them to select a reason for their withdrawal.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdown hideOwnerInPersonDropdown When in-person is enabled, defines whether the package owner is present in the signer dropdown menu.
showOwnerInPersonDropdown (default)
First Affidavit disableFirstAffidavit When in-person is enabled, defines whether the first affidavit page is shown when switching signers from the signer dropdown menu.
enableFirstAffidavit (default)
Second Affidavit disableSecondAffidavit When in-person is enabled, defines whether the second affidavit page is shown when switching signers from the dropdown menu.
enableSecondAffidavit (default)
Decline withDecline Defines whether a signer can decline the document package.
withoutDecline (default)
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over link withHandOverLinkHref Replaces the continue button in the signing ceremony. If replaced, the signer will be redirected to a URL you specify.
withHandOverLinkText Defines the text that will appear on the handover button.
withHandOverLinkTooltip Defines the text that will appear when hovering over the handover button.
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on complete withoutDialogOnComplete (default)
withDialogOnComplete Defines whether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.

Signing Ceremony Layout Settings

Here is an example of the default OneSpan Sign Signing Ceremony layout, with labels for each section. The table below provides a brief description of the layout sections that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Capture

Setting Name Ceremony Layout Settings Method Description
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
withoutNavigator
Global Navigation withGlobalNavigation (default) Shows the global navigation.
withoutGlobalNavigation
Bread Crumbs withBreadCrumbs (default) Shows signature bread crumbs.
withoutBreadCrumbs
Session Bar withSessionBar (default) Shows the session bar.
withoutSessionBar
Title withTitle (default) Shows the title
withoutTitle
Progress Bar withProgressBar (default) Shows the progress bar.
withoutProgressBar
Logo withLogoSource Replaces the default OneSpan Sign logo with a custom logo. A valid URL to the custom logo needs to be passed as an argument.
Download Button withGlobalDownloadButton (default) Shows the Download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout Button withGlobalSaveAsLayoutButton (default) Shows the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

Customizing the Signing Ceremony

The sample code below shows you how to edit the settings block. Each setting has been described above.

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

 .withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()   .withInPerson()   .withOptOutOther()   .withDeclineOther()   .withOptOut()   .withOptOutReason("Decline terms.")   .withoutLanguageDropDown()   .hideOwnerInPersonDropDown()   .disableFirstAffidavit()   .disableSecondAffidavit()   .withDecline()   .withoutWatermark()   .withCaptureText()   .withHandOverLinkHref("http://www.google.com")   .withHandOverLinkText("Exit to site")   .withHandOverLinkTooltip("You will redirected to Google homepage")   .withDocumentToolbarDownloadButton()   .withDialogOnComplete()   .withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()   .withNavigator()   .withoutGlobalNavigation()   .withoutBreadCrumbs()   .withSessionBar()   .withTitle()   .withProgressBar()   .withoutGlobalDownloadButton()   .withoutGlobalSaveAsLayoutButton()   .withLogoSource("http://www.logo-maker.net/images/common/company-logo8.gif"))) 

Results

Once you have completed the customization of the Signing Ceremony your signers will see the customization settings and layout that you have defined for them.

To download the full code sample see our Code Share site.

The OneSpan Sign Signing Ceremony can be customized. By customizing the Signing Ceremony you can seamlessly integrate the signing process within your own site.

Document Package Settings

The following table provides a brief description of the Signing Ceremony settings that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Setting Name Document Package Settings Method Description
In-person withInPerson Defines whether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out Other withOptOutOther (default) Defines whether the package sender/owner can opt-out.
withoutOptOutOther
Opt-Out withOptOut (default) Allows a signer to not participate in the signing ceremony.
withoutOptOut
Opt-Out Reason withOptOutReason If a signer decides to opt-out, allows them to select a reason for their withdrawal.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdown hideOwnerInPersonDropdown When in-person is enabled, defines whether the package owner is present in the signer dropdown menu.
showOwnerInPersonDropdown (default)
First Affidavit disableFirstAffidavit When in-person is enabled, defines whether the first affidavit page is shown when switching signers from the signer dropdown menu.
enableFirstAffidavit (default)
Second Affidavit disableSecondAffidavit When in-person is enabled, defines whether the second affidavit page is shown when switching signers from the dropdown menu.
enableSecondAffidavit (default)
Decline withDecline Defines whether a signer can decline the document package.
withoutDecline (default)
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over link withHandOverLinkHref Replaces the continue button in the signing ceremony. If replaced, the signer will be redirected to a URL you specify.
withHandOverLinkText Defines the text that will appear on the handover button.
withHandOverLinkTooltip Defines the text that will appear when hovering over the handover button.
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on complete withoutDialogOnComplete (default)
withDialogOnComplete Defines whether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.

Signing Ceremony Layout Settings

Here is an example of the default OneSpan Sign Signing Ceremony layout, with labels for each section. The table below provides a brief description of the layout sections that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Capture

Setting Name Ceremony Layout Settings Method Description
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
withoutNavigator
Global Navigation withGlobalNavigation (default) Shows the global navigation.
withoutGlobalNavigation
Bread Crumbs withBreadCrumbs (default) Shows signature bread crumbs.
withoutBreadCrumbs
Session Bar withSessionBar (default) Shows the session bar.
withoutSessionBar
Title withTitle (default) Shows the title
withoutTitle
Progress Bar withProgressBar (default) Shows the progress bar.
withoutProgressBar
Logo withLogoSource Replaces the default OneSpan Sign logo with a custom logo. A valid URL to the custom logo needs to be passed as an argument.
Download Button withGlobalDownloadButton (default) Shows the Download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout Button withGlobalSaveAsLayoutButton (default) Shows the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

Customizing the Signing Ceremony

The sample code below shows you how to edit the settings block. Each setting has been described above.

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

 .WithSettings(DocumentPackageSettingsBuilder.NewDocumentPackageSettings()   .WithInPerson()   .WithOptOutOther()   .WithDeclineOther()   .WithOptOut()   .WithOptOutReason("Decline terms.")   .WithoutLanguageDropDown()   .HideOwnerInPersonDropDown()   .DisableFirstAffidavit()   .DisableSecondAffidavit()   .WithDecline()   .WithoutWatermark()   .WithCaptureText()   .WithHandOverLinkHref("http://www.google.com")   .WithHandOverLinkText("Exit to site")   .WithHandOverLinkTooltip("You will redirected to Google homepage")   .WithoutDocumentToolbarDownloadButton()   .WithoutDialogOnComplete()   .WithCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.NewCeremonyLayoutSettings()   .WithNavigator()   .WithoutGlobalNavigation()   .WithoutBreadCrumbs()   .WithSessionBar()   .WithTitle()   .WithProgressBar()   .WithoutGlobalDownloadButton()   .WithoutGlobalSaveAsLayoutButton()   .WithLogoImageSource("http://www.logo-maker.net/images/common/company-logo8.gif"))) 

Results

Once you have completed the customization of the Signing Ceremony your signers will see the customization settings and layout that you have defined for them.

To download the full code sample see our Code Share site.

The OneSpan Sign Signing Ceremony can be customized. By customizing the Signing Ceremony you can seamlessly integrate the signing process within your own site.

Document Package Settings

The following table provides a brief description of the Signing Ceremony settings that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Setting Name Document Package Settings Method Description
In-person withInPerson Defines whether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out Other withOptOutOther (default) Defines whether the package sender/owner can opt-out.
withoutOptOutOther
Opt-Out withOptOut (default) Allows a signer to not participate in the signing ceremony.
withoutOptOut
Opt-Out Reason withOptOutReason If a signer decides to opt-out, allows them to select a reason for their withdrawal.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdown hideOwnerInPersonDropdown When in-person is enabled, defines whether the package owner is present in the signer dropdown menu.
showOwnerInPersonDropdown (default)
First Affidavit disableFirstAffidavit When in-person is enabled, defines whether the first affidavit page is shown when switching signers from the signer dropdown menu.
enableFirstAffidavit (default)
Second Affidavit disableSecondAffidavit When in-person is enabled, defines whether the second affidavit page is shown when switching signers from the dropdown menu.
enableSecondAffidavit (default)
Decline withDecline Defines whether a signer can decline the document package.
withoutDecline (default)
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over link withHandOverLinkHref Replaces the continue button in the signing ceremony. If replaced, the signer will be redirected to a URL you specify.
withHandOverLinkText Defines the text that will appear on the handover button.
withHandOverLinkTooltip Defines the text that will appear when hovering over the handover button.
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on complete withoutDialogOnComplete (default)
withDialogOnComplete Defines whether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.

Signing Ceremony Layout Settings

Here is an example of the default OneSpan Sign Signing Ceremony layout, with labels for each section. The table below provides a brief description of the layout sections that can be customized. Note that it is not required to specify any of these settings. If a setting is not defined, the default values shown below will be used.

Capture

Setting Name Ceremony Layout Settings Method Description
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
withoutNavigator
Global Navigation withGlobalNavigation (default) Shows the global navigation.
withoutGlobalNavigation
Bread Crumbs withBreadCrumbs (default) Shows signature bread crumbs.
withoutBreadCrumbs
Session Bar withSessionBar (default) Shows the session bar.
withoutSessionBar
Title withTitle (default) Shows the title
withoutTitle
Progress Bar withProgressBar (default) Shows the progress bar.
withoutProgressBar
Logo withLogoSource Replaces the default OneSpan Sign logo with a custom logo. A valid URL to the custom logo needs to be passed as an argument.
Download Button withGlobalDownloadButton (default) Shows the Download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout Button withGlobalSaveAsLayoutButton (default) Shows the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

Customizing the Signing Ceremony

The sample JSON below shows you how to edit the settings object.Each method has been described above, in the Document Pacakge Level Settings section.

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key
 {   "name": "Customizing Signing Ceremony",   "settings": {   "ceremony": {   "events": {   "complete": {   "dialog": true,   "redirect": ""   }   },   "inPerson": true,   "declineButton": true,   "declineReasons": [],   "disableDeclineOther": false,   "disableDownloadForUncompletedPackage": false,   "disableFirstInPersonAffidavit": true,   "disableInPersonAffidavit": false,   "disableOptOutOther": false,   "disableSecondInPersonAffidavit": true,   "documentToolbarOptions": {   "downloadButton": true   },   "handOver": {   "title": "You will be redirected to Google homepage",   "href": "http://www.google.com",   "text": "Exit to site"   },   "hideCaptureText": false,   "hideLanguageDropdown": true,   "hidePackageOwnerInPerson": true,   "hideWatermark": true,   "maxAuthFailsAllowed": 3,   "optOutButton": true,   "optOutReasons": [   "Decline terms."   ],   "style": null,   "layout": {   "footer": {},   "navigator": true,   "brandingBar": {   "logo": {   "src": "http://www.logo-maker.net/images/common/company-logo8.gif",   "link": ""   }   },   "header": {   "feedback": true,   "globalActions": {   "confirm": true,   "download": false,   "hideEvidenceSummary": false,   "saveAsLayout": false   },   "titleBar": {   "title": true,   "progressBar": true   },   "breadcrumbs": false,   "globalNavigation": false,   "sessionBar": true   }   }   }   },   "type": "PACKAGE",   "status": "DRAFT"   } 

Response Payload

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Results

Once you have completed the customization of the Signing Ceremony your signers will see the customization settings and layout that you have defined for them.