How do I route document completion notifications to a specific provider?

If multiple providers use the same BoldSign account, you can route document completion notifications to the correct provider by creating a separate Sender Identity for each provider and specifying that Sender Identity in the onBehalfOf field when sending documents through the API.

This ensures the completion notification is sent to the provider associated with the document.

Prerequisites

Before you begin, ensure that:

• A separate Sender Identity has been created for each provider.
• Completion notifications are enabled for each Sender Identity.
• Documents are sent using the BoldSign API.

Route completion notifications to a specific provider

Step 1: Create a Sender Identity for each provider

1. In BoldSign, go to API > Sender Identities.
2. Create a Sender Identity for the provider.
3. Save the Sender Identity.

Step 2: Enable completion notifications for the Sender Identity

1. Open the Sender Identity.
2. Go to its email notification settings.
3. Configure notifications for the sender identity
4. Enable Document has been completed by all recipients.
5. Save the changes.

Step 3: Send the document using the correct Sender Identity

When sending the document through the API, set the onBehalfOf property to the Sender Identity ID for the provider who should receive the completion notification.

Example

{
 "title": "Patient Consent Form",
 "message": "Kindly review and sign the document.",
 "onBehalfOf": "senderidentity_f8a4c6",
 "signers": [
   {
     "name": "John Doe",
     "emailAddress": "[email protected]"
   }
 ]
} 

In this example, the value set in onBehalfOf determines which Sender Identity receives the completion notification.

Do I need a separate workflow for each provider?

• No. Once a Sender Identity has been created for each provider, your application can dynamically populate the onBehalfOf property when sending documents.
• This allows a single integration to route completion notifications to the appropriate provider, even when supporting a large number of providers.

After the document is completed, the completion notification is sent to the provider associated with the Sender Identity specified in the onBehalfOf property.