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.

Geolocation

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

Show options

requestGeoLocation

boolean

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

geoLocationOptions

object

Customize how Geolocation is collected. 3.6

Show properties

required

boolean

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

requiredSign

boolean

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

requiredSignaturePad

boolean

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

requiredMeeting

boolean

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

requiredVerification

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

securityCode

boolean

Enabled 2FA security code.

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

securityPassphrase

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

styleInkColor

string

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

defaultMark

string

Set preferred default mark type. 4.0

Hide values

markAll

boolean

Enable all mark types.

markClickToSign

boolean

Enabled click to sign Accept It.

markTypeToSign

boolean

Enabled type to sign Type It.

markTouchToSign

boolean

Enabled touch to sign Ink It.

allowMarkTouchToSignMouse

boolean

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

Video Signing Room

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

Show options

meetingVideoRecordingAuto

boolean

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

meetingVideoRecordingDisabled

boolean

Disables video recording feature preventing host from recording signing session.

meetingVideoRetentionPeriod

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.

notifyMeeting

boolean

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

notifyMeetingIcsAttachment

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

Geolocation

Multi-Factor Authentication (MFA)

Signatures

Video Signing Room

Getting started

Guides

API

Webhooks

Reference

​Overview

​Defaults

​Geolocation

​Multi-Factor Authentication (MFA)

​Signatures

​Video Signing Room

Overview

Defaults

Geolocation

Multi-Factor Authentication (MFA)

Signatures

Video Signing Room