Signer Experience Settings

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

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.

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 be 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.

.NET SDK

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.

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.

REST API

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.

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.