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

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

Document Package Settings

The following table provides a brief description of the Signer Experience 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)
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)
Decline Reason withDeclineReason Defines a predefined decline reason for when a signer refuses to sign a package.
Decline Other withDeclineOther (default) Allows a signer to enter a different reason for refusing to sign a package.
  withoutDeclineOther Prevents a signer from entering a different reason for refusing to sign a package.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the Signer Experience page is displayed.
withoutLanguageDropdown
Display Help Page withShowNseHelp Defines whether a help page will be displayed, where you can provide descriptive instructions, external site links, or contact information that the signer can use for additional information or instructions.
  withoutShowNseHelp (default)  
Hand-over link withHandOverLinkHref Replaces the continue button in the Signer Experience. If replaced, the signer will be redirected to a URL you specify.
Hand-over link Tooltip withHandOverLinkHrefTooltip Defines the text that will appear when hovering over the handover button.
HandOver Link Parameters withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS")) Defines which parameters will be appended to the Handover URL. The available options are ["PACKAGE", "SIGNER", "STATUS"]. If left empty, no parameters will be appended.
HandOver Link Auto-Redirect withHandOverLinkAutoRedirect Automatically redirects the signer to the handover URL page once the signer has completed signing.
  withoutHandOverLinkAutoRedirect (default)  
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText (default) Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
  withoutNavigator  
Title withTitle (default) Shows the title.
  withoutTitle  
Progress Bar withProgressBar (default) Shows the progress bar.
  withoutProgressBar  
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
Show Logo In iFrame withShowNseLogoInIframe Defines whether to display a logo when the New Signer Experience is presented in an iFrame,
  withoutShowNseLogoInIframe (default)  
Show Overview Page withShowNseOverview Defines whether to display an overview page before a signer can begin to sign the package.
  withoutShowNseOverview (default)  
Left Menu Expand withLeftMenuExpand Defines whether the left menu will be expanded by default.
  withoutLeftMenuExpand (default)  
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.

Customizing the Signer Experience

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 Signer Experience 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 Signer Experience can be customized. By customizing the Signer Experience you can seamlessly integrate the signing process within your own site.

Document Package Settings

The following table provides a brief description of the Signer Experience 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)
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)
Decline Reason withDeclineReason Defines a predefined decline reason for when a signer refuses to sign a package.
Decline Other withDeclineOther (default) Allows a signer to enter a different reason for refusing to sign a package.
  withoutDeclineOther Prevents a signer from entering a different reason for refusing to sign a package.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the Signer Experience page is displayed.
withoutLanguageDropdown
Display Help Page withShowNseHelp Defines whether a help page will be displayed, where you can provide descriptive instructions, external site links, or contact information that the signer can use for additional information or instructions.
  withoutShowNseHelp (default)  
Hand-over link withHandOverLinkHref Replaces the continue button in the Signer Experience. If replaced, the signer will be redirected to a URL you specify.
Hand-over link Tooltip withHandOverLinkHrefTooltip Defines the text that will appear when hovering over the handover button.
HandOver Link Parameters withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS")) Defines which parameters will be appended to the Handover URL. The available options are ["PACKAGE", "SIGNER", "STATUS"]. If left empty, no parameters will be appended.
HandOver Link Auto-Redirect withHandOverLinkAutoRedirect Automatically redirects the signer to the handover URL page once the signer has completed signing.
  withoutHandOverLinkAutoRedirect (default)  
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText (default) Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
  withoutNavigator  
Title withTitle (default) Shows the title.
  withoutTitle  
Progress Bar withProgressBar (default) Shows the progress bar.
  withoutProgressBar  
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
Show Logo In iFrame withShowNseLogoInIframe Defines whether to display a logo when the New Signer Experience is presented in an iFrame,
  withoutShowNseLogoInIframe (default)  
Show Overview Page withShowNseOverview Defines whether to display an overview page before a signer can begin to sign the package.
  withoutShowNseOverview (default)  
Left Menu Expand withLeftMenuExpand Defines whether the left menu will be expanded by default.
  withoutLeftMenuExpand (default)  
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.

Customizing the Signer Experience

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()
				.withLanguageDropDown()
				.hideOwnerInPersonDropDown()
				.disableFirstAffidavit()
				.disableSecondAffidavit()
				.withDecline()
				.withDeclineOther()
				.withDeclineReason("some reason")
				.withoutWatermark()
				.withoutCaptureText()
				.withoutHandOverLinkAutoRedirect()
				.withHandOverLinkHref("http://www.google.com")
				.withHandOverLinkTooltip("You will redirected to Google homepage")
				.withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS"))
				
				.withLeftMenuExpand()
				.withShowNseHelp()
				.withShowNseLogoInIframe()
				.withShowNseOverview()
				.withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()
							.withoutNavigator()
							.withoutProgressBar()
							.withoutTitle()
							.withGlobalDownloadButton()

Results

Once you have completed the customization of the Signer Experience 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 Signer Experience can be customized. By customizing the Signer Experience you can seamlessly integrate the signing process within your own site.

Document Package Settings

The following table provides a brief description of the Signer Experience 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)
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)
Decline Reason withDeclineReason Defines a predefined decline reason for when a signer refuses to sign a package.
Decline Other withDeclineOther (default) Allows a signer to enter a different reason for refusing to sign a package.
  withoutDeclineOther Prevents a signer from entering a different reason for refusing to sign a package.
Language Dropdown withLanguageDropdown (default) Defines whether the language drop down menu from the Signer Experience page is displayed.
withoutLanguageDropdown
Display Help Page withShowNseHelp Defines whether a help page will be displayed, where you can provide descriptive instructions, external site links, or contact information that the signer can use for additional information or instructions.
  withoutShowNseHelp (default)  
Hand-over link withHandOverLinkHref Replaces the continue button in the Signer Experience. If replaced, the signer will be redirected to a URL you specify.
Hand-over link Tooltip withHandOverLinkHrefTooltip Defines the text that will appear when hovering over the handover button.
HandOver Link Parameters withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS")) Defines which parameters will be appended to the Handover URL. The available options are ["PACKAGE", "SIGNER", "STATUS"]. If left empty, no parameters will be appended.
HandOver Link Auto-Redirect withHandOverLinkAutoRedirect Automatically redirects the signer to the handover URL page once the signer has completed signing.
  withoutHandOverLinkAutoRedirect (default)  
Watermark withWatermark (default) Defines whether the signed documents are stamped with the OneSpan Sign logo.
withoutWatermark
Capture text withCaptureText (default) Defines whether the signed documents are stamped with the date, time, and signer’s name at each location they were signed.
withoutCaptureText
Navigator withNavigator (default) Shows the Navigator. The Navigator directs the signer to the next available signature.
  withoutNavigator  
Title withTitle (default) Shows the title.
  withoutTitle  
Progress Bar withProgressBar (default) Shows the progress bar.
  withoutProgressBar  
Download Button withDocumentToolbarDownloadButton (default) Defines whether the download button is available.
Show Logo In iFrame withShowNseLogoInIframe Defines whether to display a logo when the New Signer Experience is presented in an iFrame,
  withoutShowNseLogoInIframe (default)  
Show Overview Page withShowNseOverview Defines whether to display an overview page before a signer can begin to sign the package.
  withoutShowNseOverview (default)  
Left Menu Expand withLeftMenuExpand Defines whether the left menu will be expanded by default.
  withoutLeftMenuExpand (default)  
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.

Customizing the Signer Experience

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 Signer Experience",   "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 Signer Experience your signers will see the customization settings and layout that you have defined for them.