Configuring Document Visibility

Overview

Document Visibility is a popular DocuSign feature that allows customers to restrict certain forms from going to certain signers in an envelope. In Quik!, this is accomplished by “excluding” forms in the Quik! Forms Engine, by role. One common use case is when an advisor has combined their Broker-Dealer forms and Custodian forms into a single package for their client to e-sign, but the custodian firm only wants to receive their own forms from the package. Using this feature, the advisor can specify that only the custodian’s forms get sent to them, while allowing the client to still receive (and sign) all forms in the page.

Please see How to Configure Recipient Settings for more information.

Technical Overview

By default, all signers receive all forms in a generated package. To leverage Document Visibility:

The customer’s Docusign account must have Document Visibility enabled.
The following Quik! properties must be set to true within the ESignType section of your execute/html request:
- SignMultipleDocs
- EnforceSignerVisibility

Forms can be excluded via:

ExcludedDocuments (by Form ID)
ExcludedLibraries (by Library ID) *NEW in upcoming release: Release 98
These can be used independently or in combination.

Important: You cannot exclude a document from a signer if that signer has fields on the excluded form.

Use Case #1

In this example, say an advisor belongs to the Trustman Financial Broker-Dealer, and they clear with Pershing. They are opening a new IRA account for a client that requires the client to complete and sign a IRA Application form from their Broker-Dealer (Form ID 38002) as well as an IRA Application with Pershing (Form ID 218). They want their client to sign both forms, but the OSJ only wants to receive the Pershing form, so the customer will only send the Pershing form to the OSJ to sign, and exclude the Trustman form. See sample code below for configuring this request.

{
   "QuikFormID": "38002,218",
   "ESignType": {
      "Type": "Docusign",
      "AuthUserID": "{{YourAuthUserID}}",
        "SignCallBackURL": "{{YourSignCallBackURL}}",
        "SignEnvironmentID": {{YourSignEnvironment}},
      "SignMultipleDocs": true,
      "EnforceSignerVisibility": true,
      "Recipients": {
         "Signers": [
            {
               "Role": "1osj",
               "ExcludedDocuments": [38002]
            }
         ]
      }
   }

Use Case #2:

Similarly to Use Case #1, let’s say that instead of an OSJ being required to sign as Pershing, Pershing only wants to receive a signed carbon copy of their own forms, and no one at Pershing is required to sign. In this case, we can configure ExtraRecipients to send Pershing a carbon copy of only the signed Pershing form (Form ID 218).

In the below example, Owner 1 is being asked to sign all forms, and a carbon copy of Form ID 218 is being sent to Pershing as an ExtraRecipient.

{
    "QuikFormID": "38002,218",
    "ESignType": {
        "Type": "Docusign",
        "AuthUserID": "{{YourAuthUserID}}",
        "SignCallBackURL": "{{YourSignCallBackURL}}",
        "SignEnvironmentID": {{YourSignEnvironment}},
        "SignMultipleDocs": true,
        "EnforceSignerVisibility": true,
        "Recipients": {
            "Signers": [
                {
                    "Role": "1own",
                    "SendType": "EmailToSign"
                }
            ],
            "ExtraRecipients": [
                { 
                    "Name": "Pershing Recipient",
                    "Email": "Pershing Email", 
                    "RecipientNumber": 1,
                    "ExcludedDocuments": [38002] 
                }
            ]
        }
    }
}

Please note that you will need to configure a custom Sign Message since by default, all forms will be listed in the sign message (including excluded documents).

`ExcludedDocuments` with Form Group Instances

In the following scenario, you have several Form Groups, each containing forms from different Broker Dealers:

Form Group 1: Form ID 12 (American Funds) and Form ID 44252 (Charles Schwab)
Form Group 2: Form ID 441 (Pershing)
Form Group 3: Form ID 36930 (Pershing)

When sending an envelope containing multiple Broker Dealer forms, each Broker Dealer should only receive their respective forms. This means:

American Funds should only receive Form ID 12
Charles Schwab should only receive Form ID 44252
Pershing should only receive Form IDs 441 and 36930

The sample code below demonstrates how to configure this:

{
    "HostFormOnQuik": true,
    "QuikFormID": "12,44252-441-36930",
    "ESignType": {
        "Type": "docusign",
        "AuthUserID": "{{YourAuthUserID}}",
        "SignCallBackURL": "{{YourSignCallBackURL}}",
        "SignEnvironmentID": {{YourSignEnvironment}},
        "SignMultipleDocs": true,
        "EnforceSignerVisibility": true,
        "Recipients": {
            "ExtraRecipients": [
              {
                "Order": 20,
                "Name": "American Funds Recipient",
                "Email": "American Funds Recipient", 
                "RecipientNumber": 1,
                "ExcludedDocuments": ["44252","441-1000","36930-2000"]
              },
              {
                "Order": 21,
                "Name": "Charles Schwab Recipient",
                "Email": "Charles Schwab Email",
                "RecipientNumber": 2,
                "ExcludedDocuments": ["12","441-1000","36930-2000"]
              },
              {
                "Order": 22,
                "Name": "Pershing Recipient",
                "Email": "Pershing Email",
                "RecipientNumber": 3,
                "ExcludedDocuments": ["12","44252"]
              }
           ]
        }
    }
}

Upcoming Enhancement: Excluding by Library

As of Release 98, Quik! will support a new property: ExcludedLibraries

This enhancement simplifies Document Visibility configuration by allowing you to exclude entire Libraries rather than listing each Form ID individually.

Benefits:

Automatically excludes all forms belonging to the specified Library IDs.
Significantly reduces manual configuration for large or structured bundles
Fully compatible with Form Group Instances.

Prerequisites:

To exclude documents on a per-library basis, you will need to know the Library ID. Contact support@quikforms.com with the library names to obtain the Library IDs.

`ExcludedLibraries` with Form Group Instances

The payload below demonstrates how ExcludedLibraries can be used to configure a document set with three Form Groups from different Broker-Dealers. Each ExtraRecipient receives only the forms relevant to their firm, without needing to list individual Form IDs.

The following payload contains 3 form groups:

Group 1:
- Form ID 12: American Funds (Dealer ID 7)
- Form ID 44252: Charles Schwab (Dealer ID 744)
Group 2:
- Form ID 441: Pershing (Dealer ID 124)
Group 3:
- Form ID 36930: Pershing (Dealer ID 124)


{
    "HostFormOnQuik": true,
    "QuikFormID": "12,44252-441-36930",
    "ESignType": {
        "Type": "docusign",
        "AuthUserID": "{{YourAuthUserID}}",
        "SignCallBackURL": "{{YourSignCallBackURL}}",
        "SignEnvironmentID": {{YourSignEnvironment}},
        "EnableESignEdits": true,
        "EnforceSignerVisibility": true, // Required
        "SignMultipleDocs": true,  // Required
        "Recipients": {          
            "ExtraRecipients": [
                {
                    "Order": 1,
                    "Name": "American Funds Recipient CC",
                    "Email": "American Funds Email", 
                    "RecipientNumber": 1,
                    "ExcludedLibraries": [744, 124] // This recipient will only receive Form ID 12
                },
                {
                    "Order": 1,
                    "Name": "Charles Schwab Recipient CC",
                    "Email": "Charles Schwab Email", 
                    "RecipientNumber": 2,
                    "ExcludedLibraries": [7, 124] // This recipient will only receive Form ID 44252
                },
                {
                    "Order": 1,
                    "Name": "Pershing Recipient CC",
                    "Email": "Pershing Email",
                    "RecipientNumber": 3,
                    "ExcludedLibraries": [7, 744] // This recipient will only receive Form IDs 441 and 36930
                }
            ]
        }
    }
}

With ExcludedLibraries, you no longer need to manually list each Form ID per recipient. Form Group Instances are automatically taken into account, so you don’t need to include the instance suffix at the end of the Library ID.