Package options

Overview

When creating a signing package, you can configure various package options to tailor the signing experience to your needs. These options include settings for reminders, expiration, authentication, and more. See the Package options reference for more information.

Defaults

You can manage the default package options for your entire organization under Settings > Signing Defaults. These defaults will apply to all packages unless overridden at the package level through package options. Release 4.2 adds package-level consent controls. Enable consent with consentOptions.required, then select the actions that require consent.

{
  "options": {
    "cac": "none",
    "consentOptions": {
      "required": true,
      "requiredSigning": true,
      "requiredVideoRecording": false,
      "autoAcceptPolicyDays": 90
    }
  }
}

required defaults to false, requiredSigning defaults to true, requiredVideoRecording defaults to false, and autoAcceptPolicyDays defaults to 90.

When cac is none, consent must be enabled for signing or supported video recording. Video recording consent is only available for Video Signing Room packages.

autoAcceptPolicyDays lets a member reuse a previously accepted consent when the consent type and notice version are unchanged. Set it to 0 to require a new acceptance each time. Use notices to append custom text to the system notice for signing, verification, or video_recording. Provide a default value and optional locale-specific values.

{
  "options": {
    "notices": {
      "signing": {
        "default": "I agree to use an electronic signature.",
        "locale": {
          "fr": "J'accepte d'utiliser une signature electronique.",
          "es": "Acepto usar una firma electronica.",
          "de": "Ich stimme der Verwendung einer elektronischen Signatur zu."
        }
      }
    }
  }
}

Custom notice values are limited to 1,024 characters and cannot contain website domains or email addresses. Locale lookup uses the exact locale, then its language, then the default value.

Digital signatures

Release 4.2 adds digital signature provider configuration. Map each enabled signature type to one or more providers.

{
  "options": {
    "cac": "none",
    "formFlattening": "none",
    "consentOptions": {
      "required": true,
      "requiredSigning": true
    },
    "digitalSignatures": {
      "signatureTypes": {
        "qes": ["digidentity"]
      }
    }
  }
}

The supported signature type is qes (Qualified Electronic Signature). Digital signatures require signing consent, cac set to none, and formFlattening set to none or omitted. Signature types and providers must also be enabled for your subscription and organization.

Geolocation

When creating a signing package, you can enable geolocation tracking to capture the signer’s location during the signing process.

Show options

boolean

Request Signers Geolocation while signing documents, joining VSR meetings, performing IDV, and connecting to a mobile signature pad.

object

Customize how Geolocation is collected. 3.6

Show properties

boolean

Require geolocation to be shared before allowing the signer to continue.

boolean

Require geolocation to be shared before the signer can sign documents. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can use signature pad. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can join VSR meetings. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can verify their identity. (required must also be set to true)

Multi-Factor Authentication (MFA)

You can enhance the security of your signing packages by enabling Multi-Factor Authentication (MFA) for signers. This adds an extra layer of verification during the signing process.

Show options

boolean

Enabled 2FA security code.

All signers will require a valid mobile phone number to enable mobile MFA.

boolean

Enabled 2FA security passphrase.

You must also set a passphrase as part of add or update request to enabled 2FA security passphrase.

{
    "options": {
        "securityPassphrase": true,
        ...
    },
    "securityPassphrase": "mySecretPassphrase"
}

Signatures

You can customize signature options to control how signers sign the documents.

Show options

string

Override the default ink color #0000FF for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value. 2.10

string

Set preferred default mark type. 4.0

Hide values

boolean

Enable all mark types.

boolean

Enabled click to sign Accept It.

boolean

Enabled type to sign Type It.

boolean

Enabled touch to sign Ink It.

boolean

Allows signer to use desktop mouse to draw signature via touch to sign.

boolean

Allow signers to apply their last used iink signature during a signing session. Defaults to false. 4.1

Video Signing Room

When creating a Video Signing Room (VSR) package, you can configure specific options to enhance the VSR experience.

Show options

boolean

Automatically starts video recording after host starts meeting and first attendee joins.

boolean

Disables video recording feature preventing host from recording signing session.

string

Add a retention period to all package videos to prevent deletion. (ISO 8601 duration)

Share meeting details and videos with guest signers via MasterFile.

boolean

Send email notification to each signer when Video Signing Room meeting is scheduled.

boolean

Include ICS compatible meeting invitation with email notification to schedule meeting date and time in recipients’ calendar.

Getting started

Guides

API

Webhooks

Reference

Overview

Defaults

Digital signatures

Geolocation

Multi-Factor Authentication (MFA)

Signatures

Video Signing Room

​Overview

​Defaults

​Consent

​Custom consent notices

​Digital signatures

​Geolocation

​Multi-Factor Authentication (MFA)

​Signatures

​Video Signing Room

Overview

Defaults

Consent

Custom consent notices

Digital signatures

Geolocation

Multi-Factor Authentication (MFA)

Signatures

Video Signing Room