> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Package options

<ParamField body="embedded" type="boolean">
  Enable embedded signing mode.
</ParamField>

<ParamField body="embed" type="object">
  Embed options used to customize the embedded package editor.
  <Badge icon="sparkles" size="sm" color="purple">2.8</Badge>

  <Expandable title="properties">
    <ParamField body="disableSend" type="boolean">
      User can only save changes to draft packages; the user will not be able to send it.
    </ParamField>

    <ParamField body="disableProperties" type="boolean">
      User will not be allowed to modify package properties.
    </ParamField>

    <ParamField body="disableVerification" type="boolean">
      User will not be allowed to modify package verification properties.
    </ParamField>

    <ParamField body="disableSigners" type="boolean">
      User will not be allowed to modify package signers.
    </ParamField>

    <ParamField body="disableDocuments" type="boolean">
      User will not be allowed to modify package documents.
    </ParamField>

    <ParamField body="disableEditing" type="boolean">
      User will not be allowed to modify package properties, verification properties, signers, or documents. They will still be allowed to template each document.
    </ParamField>

    <ParamField body="focusTemplating" type="boolean">
      The first document will be focused when the package editor is loaded instead of the package properties.
    </ParamField>

    <ParamField body="returnUrl" type="string">
      User will be redirected back to the returnUrl when they are done editing the package.
    </ParamField>

    <ParamField body="returnState" type="string">
      Will be included in a `state` query string parameter appended to the `returnUrl`.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="brandId" type="string">
  Show custom brand when signing package.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="addDocumentIdentifier" type="boolean">
  Add document identifier to each page (QR code).
</ParamField>

<ParamField body="allowReview" type="boolean">
  Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation.
  <Badge icon="sparkles" size="sm" color="purple">2.6</Badge>
</ParamField>

<ParamField body="allowForwardSignings" type="boolean">
  Allow signers to forward the signing to another email address.
  <Badge icon="sparkles" size="sm" color="purple">4.0</Badge>
</ParamField>

<ParamField body="enhancedPrivacy" type="boolean">
  Enabled to not share email addresses between signers.
  <Badge icon="sparkles" size="sm" color="purple">2.11</Badge>

  <Note>
    Supported in the following package types:

    * Concurrent (`concurrent`)
    * Sequential (`Sequential`)
    * Group Send (`Counterparts`)
  </Note>
</ParamField>

<ParamField body="formDisabled" type="boolean">
  Do not allow signers to fill AcroForm fields during signing.
  <Badge icon="sparkles" size="sm" color="purple">3.3</Badge>
</ParamField>

<ParamField body="formReadOnly" type="boolean">
  Do not allow signers to modify AcroForm fields during signing.
  <Badge icon="sparkles" size="sm" color="purple">3.6</Badge>
</ParamField>

<ParamField body="formFlattening" type="string">
  Control how Acroform fields are flattened after signing a document.
  <Badge icon="sparkles" size="sm" color="purple">2.6</Badge>

  <Expandable title="values" defaultOpen>
    | Value  | Description                          |
    | :----- | :----------------------------------- |
    | none   | Do not flatten fields                |
    | filled | Flatten only fields filled by signer |
    | all    | Flatten all fields `default`         |
  </Expandable>
</ParamField>

<ParamField body="styleInkColor" type="string">
  Override the default ink color `#0000FF` for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value.
  <Badge icon="sparkles" size="sm" color="purple">2.10</Badge>
</ParamField>

<ParamField body="defaultMark" type="string">
  Set preferred default mark type.
  <Badge icon="sparkles" size="sm" color="purple">4.0</Badge>

  <Expandable title="values" defaultOpen>
    | Value           | Description |
    | :-------------- | :---------- |
    | touch\_to\_sign | iink It     |
    | type\_to\_sign  | Type It     |
    | click\_to\_sign | Accept It   |
  </Expandable>
</ParamField>

<ParamField body="retentionPeriod" type="string">
  Add a retention period to the package to prevent deletion. (ISO 8601 duration)
  <Badge icon="sparkles" size="sm" color="purple">1.11</Badge>
</ParamField>

<ParamField body="templateParseTags" type="boolean">
  Parse document for templating tags. Defaults to true.
</ParamField>

<ParamField body="templateParseMergeDataTags" type="boolean">
  Parse merger data templating tags. Defaults to false.
  <Badge icon="sparkles" size="sm" color="purple">4.0</Badge>
</ParamField>

<ParamField body="templateUnusedSignerTags" type="string">
  Control how unused signer tags are handled.
  <Badge icon="sparkles" size="sm" color="purple">2.6</Badge>

  <Expandable title="values" defaultOpen>
    | Value  | Description                      |
    | :----- | :------------------------------- |
    | keep   | Leave unused tags in document    |
    | hide   | Move unused tags to hidden layer |
    | remove | Remove unused tags `default`     |
  </Expandable>
</ParamField>

<ParamField body="cac" type="string">
  Control which document(s) within a package have the CAC page appended to them.
  <Badge icon="sparkles" size="sm" color="purple">3.2</Badge>

  <Expandable title="values" defaultOpen>
    | 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  |
  </Expandable>
</ParamField>

<ParamField body="cacSignerIdentification" type="boolean">
  When enabled will add a signer identification placeholder for each signer on the CAC page.
  <Badge icon="sparkles" size="sm" color="purple">3.2</Badge>
</ParamField>

<ParamField body="cacText" type="string">
  Add a custom disclaimer to the top of the Compliance Audit Certificate.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="securityCode" type="boolean">
  Enabled 2FA security code.

  <Tip>
    All signers will require a valid mobile phone number to enable mobile MFA.
  </Tip>
</ParamField>

<ParamField body="securityPassphrase" type="boolean">
  Enabled 2FA security passphrase.

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

    ```json theme={null}
    {
        "options": {
            "securityPassphrase": true,
            ...
        },
        "securityPassphrase": "mySecretPassphrase"
    }
    ```
  </Tip>
</ParamField>

<ParamField body="markAll" type="boolean">
  Enable all mark types.
</ParamField>

<ParamField body="markClickToSign" type="boolean">
  Enabled click to sign `Accept It`.
</ParamField>

<ParamField body="markTypeToSign" type="boolean">
  Enabled type to sign `Type It`.
</ParamField>

<ParamField body="markTouchToSign" type="boolean">
  Enabled touch to sign `Ink It`.
</ParamField>

<ParamField body="allowMarkTouchToSignMouse" type="boolean">
  Allows signer to use desktop mouse to draw signature via touch to sign.
</ParamField>

<ParamField body="meetingVideoRecordingAuto" type="boolean">
  Automatically starts video recording after host starts meeting and first attendee joins.
</ParamField>

<ParamField body="meetingVideoRecordingDisabled" type="boolean">
  Disables video recording feature preventing host from recording signing session.
</ParamField>

<ParamField body="meetingVideoRetentionPeriod" type="string">
  Add a retention period to all package videos to prevent deletion. (ISO 8601 duration)
  <Badge icon="sparkles" size="sm" color="purple">1.11</Badge>
</ParamField>

<ParamField body="masterFileShareMeetings" type="boolean">
  Share meeting details and videos with guest signers via MasterFile.
</ParamField>

<ParamField body="notificationsOff" type="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.
  <Badge icon="sparkles" size="sm" color="purple">1.10.4</Badge>
</ParamField>

<ParamField body="notifyAttachments" type="boolean">
  Set to false to not include signed documents as attachments in executed email notifications.
  <Badge icon="sparkles" size="sm" color="purple">2.5</Badge>
</ParamField>

<ParamField body="notifyConfirmation" type="boolean">
  Send email notification to owner to confirm package was created.
</ParamField>

<ParamField body="notifyAccessed" type="boolean">
  Send email notification to owner whenever a signer opens a document (limited to once every hour).
</ParamField>

<ParamField body="notifyPackageSign" type="boolean">
  Send email notification to each signer when it is their turn to sign.
</ParamField>

<ParamField body="notifySigners" type="boolean">
  Send email notification to each signer to notify them that they are waiting their turn to sign.
</ParamField>

<ParamField body="notifyMeeting" type="boolean">
  Send email notification to each signer when Video Signing Room meeting is scheduled.
</ParamField>

<ParamField body="notifyMeetingIcsAttachment" type="boolean">
  Include ICS compatible meeting invitation with email notification to schedule meeting date and time in recipients' calendar.
</ParamField>

<ParamField body="notifyDocumentSigned" type="boolean">
  Send email notification to signer after they sign each document.
  <Badge icon="sparkles" size="sm" color="purple">2.5</Badge>
</ParamField>

<ParamField body="notifyDocumentNextAll" type="boolean">
  For Sequential packages, the next signer notification is only sent after the current signer has signed all of their documents.
  <Badge icon="sparkles" size="sm" color="purple">3.3</Badge>
</ParamField>

<ParamField body="notifyDocumentExecuted" type="boolean">
  Send email to owner to notify them when all signers have signed each document.
</ParamField>

<ParamField body="notifyDocumentExecutedAll" type="boolean">
  Don't send document executed email until all documents in the package have been fully signed.
  <Badge icon="sparkles" size="sm" color="purple">3.3</Badge>
</ParamField>

<ParamField body="notifyDocumentExecutedOwner" type="boolean">
  `Counterparts` Send document executed notification TO package owner and CC signer.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="notifyDocumentExecutedAttachRevision" type="boolean">
  Send signers fully executed document with CAC page appended to end of document.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="notifyDocumentExecutedAttachExecuted" type="boolean">
  Send signers fully executed document without CAC page appended to end of document.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="notifyDocumentExecutedAttachCac" type="boolean">
  Send signers separated CAC page as an additional attachment.
  <Badge icon="sparkles" size="sm" color="purple">1.10</Badge>
</ParamField>

<ParamField body="allowSignerTools" type="boolean">
  Allow signer to add additional fields while signing documents. Customize signerTools to control what fields the signer can add.
</ParamField>

<ParamField body="allowSignerDeleteFields" type="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.
  <Badge icon="sparkles" size="sm" color="purple">2.10</Badge>
</ParamField>

<ParamField body="signerTools" type="object">
  Customize signer toolbar options.

  <Expandable title="properties">
    <ParamField body="sign" type="boolean">
      Enable sign.
    </ParamField>

    <ParamField body="annotateMobile" type="boolean">
      Enable annotations (ink) on mobile devices.
    </ParamField>

    <ParamField body="annotateDesktop" type="boolean">
      Enable annotations (ink) on desktop.
    </ParamField>

    <ParamField body="text" type="boolean">
      Enable text.
    </ParamField>

    <ParamField body="note" type="boolean">
      Enable note.
    </ParamField>

    <ParamField body="forms" type="boolean">
      Enable forms.
    </ParamField>

    <ParamField body="autoForms" type="boolean">
      Auto highlight form fields.
    </ParamField>

    <ParamField body="image" type="boolean">
      Enable image.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="requestGeoLocation" type="boolean">
  Request Signers Geolocation while signing documents, joining VSR meetings, performing IDV, and connecting to a mobile signature pad.
</ParamField>

<ParamField body="geoLocationOptions" type="object">
  Customize how Geolocation is collected.
  <Badge icon="sparkles" size="sm" color="purple">3.6</Badge>

  <Expandable title="properties">
    <ParamField body="required" type="boolean">
      Require geolocation to be shared before allowing the signer to continue.
    </ParamField>

    <ParamField body="requiredSign" type="boolean">
      Require geolocation to be shared before the signer can sign documents.
      (`required` must also be set to `true`)
    </ParamField>

    <ParamField body="requiredSignaturePad" type="boolean">
      Require geolocation to be shared before the signer can use signature pad.
      (`required` must also be set to `true`)
    </ParamField>

    <ParamField body="requiredMeeting" type="boolean">
      Require geolocation to be shared before the signer can join VSR meetings.
      (`required` must also be set to `true`)
    </ParamField>

    <ParamField body="requiredVerification" type="boolean">
      Require geolocation to be shared before the signer can verify their identity.
      (`required` must also be set to `true`)
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="pdfSecurity" type="boolean">
  Enable custom PDF security options.
  <Badge icon="sparkles" size="sm" color="purple">2.10</Badge>
</ParamField>

<ParamField body="pdfSecurityOptions" type="object">
  Customize PDF security options.
  <Badge icon="sparkles" size="sm" color="purple">2.10</Badge>

  <Expandable title="properties">
    <ParamField body="allowAssembly" type="boolean">
      Allow PDF merge operations.
    </ParamField>

    <ParamField body="allowCopy" type="boolean">
      Allow copying PDF content.
    </ParamField>

    <ParamField body="allowDegradedPrinting" type="boolean">
      Allow only degraded PDF printing.
    </ParamField>

    <ParamField body="allowFillIn" type="boolean">
      Allow PDF AcroForms fields to be filled in (when formFlattening option is not set to "all").
    </ParamField>

    <ParamField body="allowModifyAnnotations" type="boolean">
      Allow PDF annotations.
    </ParamField>

    <ParamField body="allowModifyContents" type="boolean">
      Allow PDF editing.
    </ParamField>

    <ParamField body="allowPrinting" type="boolean">
      Allow PDF printing.
    </ParamField>

    <ParamField body="allowScreenReaders" type="boolean">
      Allow screen readers.
    </ParamField>

    <Warning>
      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.
    </Warning>
  </Expandable>
</ParamField>

<ParamField body="verificationOptions" type="object">
  Set identity verification options.
  <Badge icon="sparkles" size="sm" color="purple">3.2</Badge>

  <Expandable title="properties">
    <ParamField body="policyId" type="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.)
    </ParamField>

    <ParamField body="policyCode" type="string">
      The code of one of our standard Identity Verification Policy to use during signer identity verification.

      <Expandable title="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    |

        <Tip>
          **Pass-To-Sign** indicates whether the signer must successfully complete identity verification before they can sign their documents.
        </Tip>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="reminderOptions" type="object">
  Set package `Remind Me Later` options.
  <Badge icon="sparkles" size="sm" color="purple">4.0</Badge>

  <Expandable title="properties">
    <ParamField body="reminderDays" type="number">
      Number of days, from today, to send a reminder notification to the package owner.
    </ParamField>

    <ParamField body="reminderMessage" type="string">
      Message that will be sent with the reminder notification to package owner.
    </ParamField>
  </Expandable>
</ParamField>
