Package options - iinked Sign

embedded

boolean

Enable embedded signing mode.

embed

object

Embed options used to customize the embedded package editor. 2.8

Show properties

disableSend

boolean

User can only save changes to draft packages; the user will not be able to send it.

disableProperties

boolean

User will not be allowed to modify package properties.

disableVerification

boolean

User will not be allowed to modify package verification properties.

disableSigners

boolean

User will not be allowed to modify package signers.

disableDocuments

boolean

User will not be allowed to modify package documents.

disableEditing

boolean

User will not be allowed to modify package properties, verification properties, signers, or documents. They will still be allowed to template each document.

focusTemplating

boolean

The first document will be focused when the package editor is loaded instead of the package properties.

returnUrl

string

User will be redirected back to the returnUrl when they are done editing the package.

returnState

string

Will be included in a state query string parameter appended to the returnUrl.

brandId

string

Show custom brand when signing package. 1.10

addDocumentIdentifier

boolean

Add document identifier to each page (QR code).

allowReview

boolean

Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation. 2.6

allowForwardSignings

boolean

Allow signers to forward the signing to another email address. 4.0

enhancedPrivacy

boolean

Enabled to not share email addresses between signers. 2.11

Supported in the following package types:

Concurrent (concurrent)
Sequential (Sequential)
Group Send (Counterparts)

formDisabled

boolean

Do not allow signers to fill AcroForm fields during signing. 3.3

formReadOnly

boolean

Do not allow signers to modify AcroForm fields during signing. 3.6

formFlattening

string

Control how Acroform fields are flattened after signing a document. 2.6

Hide values

Value	Description
none	Do not flatten fields
filled	Flatten only fields filled by signer
all	Flatten all fields `default`

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

Value	Description
touch_to_sign	iink It
type_to_sign	Type It
click_to_sign	Accept It

retentionPeriod

string

Add a retention period to the package to prevent deletion. (ISO 8601 duration) 1.11

templateParseTags

boolean

Parse document for templating tags. Defaults to true.

templateParseMergeDataTags

boolean

Parse merger data templating tags. Defaults to false. 4.0

templateUnusedSignerTags

string

Control how unused signer tags are handled. 2.6

Hide values

Value	Description
keep	Leave unused tags in document
hide	Move unused tags to hidden layer
remove	Remove unused tags `default`

cac

string

Control which document(s) within a package have the CAC page appended to them. 3.2

Hide values

Value	Description
document_all	Append to all documents in package
document_first	Append to first document in package
document_last	Append to last document in package

cacSignerIdentification

boolean

When enabled will add a signer identification placeholder for each signer on the CAC page. 3.2

cacText

string

Add a custom disclaimer to the top of the Compliance Audit Certificate. 1.10

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"
}

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.

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) 1.11

Share meeting details and videos with guest signers via MasterFile.

notificationsOff

boolean

Prevent all package notifications from being sent to signers. This option will override other notify options. This option will not prevent Document Accessed (notifyAccessed) notifications if enabled. 1.10.4

notifyAttachments

boolean

Set to false to not include signed documents as attachments in executed email notifications. 2.5

notifyConfirmation

boolean

Send email notification to owner to confirm package was created.

notifyAccessed

boolean

Send email notification to owner whenever a signer opens a document (limited to once every hour).

notifyPackageSign

boolean

Send email notification to each signer when it is their turn to sign.

notifySigners

boolean

Send email notification to each signer to notify them that they are waiting their turn to sign.

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.

notifyDocumentSigned

boolean

Send email notification to signer after they sign each document. 2.5

notifyDocumentNextAll

boolean

For Sequential packages, the next signer notification is only sent after the current signer has signed all of their documents. 3.3

notifyDocumentExecuted

boolean

Send email to owner to notify them when all signers have signed each document.

notifyDocumentExecutedAll

boolean

Don’t send document executed email until all documents in the package have been fully signed. 3.3

notifyDocumentExecutedOwner

boolean

Counterparts Send document executed notification TO package owner and CC signer. 1.10

notifyDocumentExecutedAttachRevision

boolean

Send signers fully executed document with CAC page appended to end of document. 1.10

notifyDocumentExecutedAttachExecuted

boolean

Send signers fully executed document without CAC page appended to end of document. 1.10

notifyDocumentExecutedAttachCac

boolean

Send signers separated CAC page as an additional attachment. 1.10

allowSignerTools

boolean

Allow signer to add additional fields while signing documents. Customize signerTools to control what fields the signer can add.

allowSignerDeleteFields

boolean

Allow signer to delete any templated fields while signing a document. This is default behavior for VSR and In Person package types. It is recommended to use optional fields instead for Concurrent, Sequential, and Group Send package types. 2.10

signerTools

object

Customize signer toolbar options.

Show properties

sign

boolean

Enable sign.

annotateMobile

boolean

Enable annotations (ink) on mobile devices.

annotateDesktop

boolean

Enable annotations (ink) on desktop.

text

boolean

Enable text.

note

boolean

Enable note.

forms

boolean

Enable forms.

autoForms

boolean

Auto highlight form fields.

image

boolean

Enable image.

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)

pdfSecurity

boolean

Enable custom PDF security options. 2.10

pdfSecurityOptions

object

Customize PDF security options. 2.10

Show properties

allowAssembly

boolean

Allow PDF merge operations.

allowCopy

boolean

Allow copying PDF content.

allowDegradedPrinting

boolean

Allow only degraded PDF printing.

allowFillIn

boolean

Allow PDF AcroForms fields to be filled in (when formFlattening option is not set to “all”).

allowModifyAnnotations

boolean

Allow PDF annotations.

allowModifyContents

boolean

Allow PDF editing.

allowPrinting

boolean

Allow PDF printing.

allowScreenReaders

boolean

Allow screen readers.

PDF security options are enforced only when the PDF is opened in a PDF viewer that supports the PDF security settings. Not all PDF viewers support these settings.

verificationOptions

object

Set identity verification options. 3.2

Show properties

policyId

string

The policy ID of the custom Identity Verification Policy to use during signer identity verification. (Custom IDV policies currently must be created by our Support Team for your organization.)

policyCode

string

The code of one of our standard Identity Verification Policy to use during signer identity verification.

Show Verification policies

Policy Code	Pass-To-Sign	Region	Retries
trulioo3_document	false	Any	2
trulioo3_document_required	true	Any	2
trulioo3_document_ca_strict	false	CA	2
trulioo3_document_ca_strict_required	true	CA	2

Pass-To-Sign indicates whether the signer must successfully complete identity verification before they can sign their documents.

reminderOptions

object

Set package Remind Me Later options. 4.0

Show properties

reminderDays

number

Number of days, from today, to send a reminder notification to the package owner.

reminderMessage

string

Message that will be sent with the reminder notification to package owner.