Configuring Document Visibility
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 Notes
By default, all signing roles will receive all forms in a generated package to sign. If a customer wishes to use Document Visibility, they must know ahead of time which Form IDs will be excluded from which signing roles.
To use this feature, the customer’s DocuSign account must have Document Visibility enabled, and the
EnforceSignerVisibility
andSignMultipleDocs
properties must be set to TRUE in the Quik! Forms Engine.Documents are excluded in
ExcludedDocuments
parameter of theRecipients
object in the API request (comma separated).Customers cannot exclude documents from a signer who has sign fields on the excluded Form IDs
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": "<MyAuthUserID>",
"SignCallbackURL": "<MySignCallbackURL>",
"SignEnvironmentID": <MySignEnvironment>,
"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": "<MyAuthUserID>",
"SignCallbackURL": "<MySignCallbackURL>",
"SignEnvironmentID": "<MySignEnvironment>",
"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).
Configuring Document Visibility 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": "<MyAuthUserID>",
"SignCallbackURL": "<MySignCallbackURL>",
"SignEnvironmentID": "<MySignEnvironment>",
"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"]
}
]
}
}
}
Related pages
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK