During the OneSpan Sign signing ceremony, you can customize the signer's experience.This allows you to seamlessly integrate the signing process within your own site.

Document Package Level Settings

Below is a brief description of each available package (transaction in the new UI) and ceremony layout settings.It is important to note that it is not required to specify any of these settings.They will default to the values shown below if not specified.Document Package Settings
Setting NameDocument Package Settings MethodDescription
In-personwithInPersonWhether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out OtherwithOptOutOther (default)Whether the package sender/owner can opt-out or not.
withoutOptOutOther
Opt-OutwithOptOut (default)Allow a signer not to participate in the signing ceremony.
withoutOptOut
Opt-Out ReasonwithOptOutReasonIf a signer decides to opt-out, he/she can select a reason for their withdrawal.
Language DropdownwithLanguageDropdown (default)Whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdownhideOwnerInPersonDropdownWhen in-person is enabled, decide whether the package is owner is present in the signer dropdown.
showOwnerInPersonDropdown (default)
First AffidavitdisableFirstAffidavitWhen in-person is enabled, decide whether the first affidavit page is shown when switching signers from the dropdown.
enableFirstAffidavit (default)
Second AffidavitdisableSecondAffidavitWhen in-person is enabled, decide whether the second affidavit page is shown when switching signers from the dropdown.
enableSecondAffidavit (default)
DeclinewithDeclineWhether a signer can decline the document package.
withoutDecline (default)
WatermarkwithWatermark (default)Whether the signed documents are stamped with the OneSpan Sign logo with each signature.
withoutWatermark
Capture textwithCaptureTextWhether the signed documents are being stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over linkwithHandOverLinkHrefReplaces the continue button in the signing ceremony.The user will be redirected to a URL you specify.
withHandOverLinkTextThe text that will appear on the handover button.
withHandOverLinkTooltipThe text that will appear when hovering over the handover button.
Download ButtonwithDocumentToolbarDownloadButton (default)Whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on completewithoutDialogOnComplete (default)
withDialogOnCompleteWhether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.
Ceremony Layout SettingsBelow is OneSpan Sign's default signing ceremony layout.Each of the sections is labeled for convenience.

Capture

Setting NameCeremony Layout Settings MethodDescription
NavigatorwithNavigator (default)Show the navigator.It directs the signer to the next available signature.
withoutNavigator
Global NavigationwithGlobalNavigation (default)Show the global navigation.
withoutGlobalNavigation
Bread CrumbswithBreadCrumbs (default)Show the bread crumbs.
withoutBreadCrumbs
Session BarwithSessionBar (default)Show the session bar.
withoutSessionBar
TitlewithTitle (default)Show the title
withoutTitle
Progress BarwithProgressBar (default)Show the progress bar.
withoutProgressBar
LogowithLogoSourceReplaces the default OneSpan Sign logo with a custom logo.A valid URL to custom logo needs to be passed as argument.
Download ButtonwithGlobalDownloadButton (default)Show the download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout ButtonwithGlobalSaveAsLayoutButton (default)Show the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

The Code

Full code for this guide can be found in the Developer Community Code Share, here.The sample code below shows you how to edit the settings block.Each method has been described above, in the Document Pacakge Level Settings section.If you need a comparison to the basic document object creation or if this is the first time creating a package with the Java SDK, see this guide.
 .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"))) 

Running Your Code

Depending on the settings you chose, your end result might be different.If you followed this guide, below is a screenshot of what you might expect:result

Get the Code

During the OneSpan Sign signing ceremony, you can customize the signer's experience.This allows you to seamlessly integrate the signing process within your own site.

Document Package Level Settings

Below is a brief description of each available package (transaction in the new UI) and ceremony layout settings.It is important to note that it is not required to specify any of these settings.They will default to the values shown below if not specified.Document Package Settings
Setting NameDocument Package Settings MethodDescription
In-personwithInPersonWhether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out OtherwithOptOutOther (default)Whether the package sender/owner can opt-out or not.
withoutOptOutOther
Opt-OutwithOptOut (default)Allow a signer not to participate in the signing ceremony.
withoutOptOut
Opt-Out ReasonwithOptOutReasonIf a signer decides to opt-out, he/she can select a reason for their withdrawal.
Language DropdownwithLanguageDropdown (default)Whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdownhideOwnerInPersonDropdownWhen in-person is enabled, decide whether the package is owner is present in the signer dropdown.
showOwnerInPersonDropdown (default)
First AffidavitdisableFirstAffidavitWhen in-person is enabled, decide whether the first affidavit page is shown when switching signers from the dropdown.
enableFirstAffidavit (default)
Second AffidavitdisableSecondAffidavitWhen in-person is enabled, decide whether the second affidavit page is shown when switching signers from the dropdown.
enableSecondAffidavit (default)
DeclinewithDeclineWhether a signer can decline the document package.
withoutDecline (default)
WatermarkwithWatermark (default)Whether the signed documents are stamped with the OneSpan Sign logo with each signature.
withoutWatermark
Capture textwithCaptureTextWhether the signed documents are being stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over linkwithHandOverLinkHrefReplaces the continue button in the signing ceremony.The user will be redirected to a URL you specify.
withHandOverLinkTextThe text that will appear on the handover button.
withHandOverLinkTooltipThe text that will appear when hovering over the handover button.
Download ButtonwithDocumentToolbarDownloadButton (default)Whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on completewithoutDialogOnComplete (default)
withDialogOnCompleteWhether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.
Ceremony Layout SettingsBelow is OneSpan Sign's default signing ceremony layout.Each of the sections is labeled for convenience.

Capture

Setting NameCeremony Layout Settings MethodDescription
NavigatorwithNavigator (default)Show the navigator.It directs the signer to the next available signature.
withoutNavigator
Global NavigationwithGlobalNavigation (default)Show the global navigation.
withoutGlobalNavigation
Bread CrumbswithBreadCrumbs (default)Show the bread crumbs.
withoutBreadCrumbs
Session BarwithSessionBar (default)Show the session bar.
withoutSessionBar
TitlewithTitle (default)Show the title
withoutTitle
Progress BarwithProgressBar (default)Show the progress bar.
withoutProgressBar
LogowithLogoSourceReplaces the default OneSpan Sign logo with a custom logo.A valid URL to custom logo needs to be passed as argument.
Download ButtonwithGlobalDownloadButton (default)Show the download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout ButtonwithGlobalSaveAsLayoutButton (default)Show the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

The Code

Full code for this guide can be found in the Developer Community Code Share, here.The sample code below shows you how to edit the settings block.Each method has been described above, in the Document Pacakge Level Settings section.If you need a comparison to the basic document object creation or if this is the first time creating a package with the .NET SDK, see this guide.
 .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"))) 

Running Your Code

Depending on the settings you chose, your end result might be different.If you followed this guide, below is a screenshot of what you might expect:result

Get the Code

During the OneSpan Sign signing ceremony, you can customize the signer's experience.This allows you to seamlessly integrate the signing process within your own site.

Document Package Level Settings

Below is a brief description of each available package (transaction in the new UI) and ceremony layout settings.It is important to note that it is not required to specify any of these settings.They will default to the values shown below if not specified.Document Package Settings
Setting NameDocument Package Settings MethodDescription
In-personwithInPersonWhether all documents in a package have to be signed on the same device.
withoutInPerson (default)
Opt-Out OtherwithOptOutOther (default)Whether the package sender/owner can opt-out or not.
withoutOptOutOther
Opt-OutwithOptOut (default)Allow a signer not to participate in the signing ceremony.
withoutOptOut
Opt-Out ReasonwithOptOutReasonIf a signer decides to opt-out, he/she can select a reason for their withdrawal.
Language DropdownwithLanguageDropdown (default)Whether the language drop down menu from the signing ceremony page is displayed.
withoutLanguageDropdown
Owner in-person dropdownhideOwnerInPersonDropdownWhen in-person is enabled, decide whether the package is owner is present in the signer dropdown.
showOwnerInPersonDropdown (default)
First AffidavitdisableFirstAffidavitWhen in-person is enabled, decide whether the first affidavit page is shown when switching signers from the dropdown.
enableFirstAffidavit (default)
Second AffidavitdisableSecondAffidavitWhen in-person is enabled, decide whether the second affidavit page is shown when switching signers from the dropdown.
enableSecondAffidavit (default)
DeclinewithDeclineWhether a signer can decline the document package.
withoutDecline (default)
WatermarkwithWatermark (default)Whether the signed documents are stamped with the OneSpan Sign logo with each signature.
withoutWatermark
Capture textwithCaptureTextWhether the signed documents are being stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText (default)
Hand-over linkwithHandOverLinkHrefReplaces the continue button in the signing ceremony.The user will be redirected to a URL you specify.
withHandOverLinkTextThe text that will appear on the handover button.
withHandOverLinkTooltipThe text that will appear when hovering over the handover button.
Download ButtonwithDocumentToolbarDownloadButton (default)Whether the download button is available.
withoutDocumentToolbarDownloadButton
Dialog on completewithoutDialogOnComplete (default)
withDialogOnCompleteWhether the completion dialog, which asks the signers if they want to review the documents or leave the system, is shown after signing.
Ceremony Layout SettingsBelow is OneSpan Sign's default signing ceremony layout.Each of the sections is labeled for convenience.

Capture

Setting NameCeremony Layout Settings MethodDescription
NavigatorwithNavigator (default)Show the navigator.It directs the signer to the next available signature.
withoutNavigator
Global NavigationwithGlobalNavigation (default)Show the global navigation.
withoutGlobalNavigation
Bread CrumbswithBreadCrumbs (default)Show the bread crumbs.
withoutBreadCrumbs
Session BarwithSessionBar (default)Show the session bar.
withoutSessionBar
TitlewithTitle (default)Show the title
withoutTitle
Progress BarwithProgressBar (default)Show the progress bar.
withoutProgressBar
LogowithLogoSourceReplaces the default OneSpan Sign logo with a custom logo.A valid URL to custom logo needs to be passed as argument.
Download ButtonwithGlobalDownloadButton (default)Show the download button in the global actions area.
withoutGlobalDownloadButton
Save As Layout ButtonwithGlobalSaveAsLayoutButton (default)Show the Save As Layout button in the global actions area.
withoutGlobalSaveAsLayoutButton

The Code

Full code for this guide can be found in the Developer Community Code Share, here.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 document object creation or if this is the first time creating a package with the REST API, see this guide.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/jsonContent-Type: application/jsonAuthorization: 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="   } 

Running Your Code

Depending on the settings you chose, your end result might be different.If you followed this guide, below is a screenshot of what you might expect:

result

Get the Code