Integrate with Borrower eSign Events

When documents for a closing are ready for borrowers to esign, Snapdocs Connect broadcasts a message to the webhook listener that you set up for those events. After receiving the message, you can call our APIs to retrieve the borrower information, including the secure token that you can use to construct an eSign link to provide the borrower. After the borrower esigns the document, Snapdocs Connect sends a subsequent webhook notification to inform you that the esign has been completed.

Subscription Events	Subscription Event Description
borrower.esigning_available	Closing documents are available for a borrower to eSign.
borrower.esigning_complete	All borrowers have eSigned the closing package.
borrower.esign_reminder	Borrower is reminded to eSign.
borrower.redraw_esigning_available	Redraw documents are available for a borrower to eSign.

How to subscribe to Borrower eSign Events

Step 1: Use a webhook listener
Create a webhook listener (or HTTPS API) to receive the borrower.esigning_available and borrower.esigning_complete events from Snapdocs Connect. You’ll use the URL as the listener webhook_url in the next step.

Note: Make sure to configure the webhook to respond to events with a 200 response. Otherwise, Snapdocs will attempt to redeliver the webhook event. See Subscriptions and Webhooks for more information.

Step 2: Subscribe to the borrower eSign events
Make a POST request to the Create a subscription endpoint to register the webhook URL and the borrower.esigning_available and borrower.esigning_complete events.
With this subscription, when the uploaded documents for the closing are ready for borrowers to eSign or when the borrowers has completed the esigning, Snapdocs sends a notification to the webhook listener.

Step 3: Handle the event payload
Write custom application code to process the response to receiving the borrower.esigning_available event, which is triggered when closing documents are ready to be eSigned.

Here’s an example of a borrower.esigning_available webhook notification from Snapdocs Connect:

JSON

{
	"event_id": "48a2pfid-a88b-4e8c-a867-07fb6bd5aled",
	"closing_uuid": "7262a37e-85b9-27d8-8622-da463e58b49b",
	"event_name": "borrower.esigning_available",
	"created_at": 1638416525,
	"payload": {
		"external identifiers": [{
			"external_system": "other_los",
			"external_type": "loan_guid",
			"value": "1234"
		}],
		"borrower_uuid": "767542da-3b5e-628e-b9bd-284d97a3b6e9"
	}
}

After the borrower esigns the document, you will receive another notification that the borrower.esigning_completed event occurred.

Multiple Borrowers

When multiple borrowers are present, Snapdocs notifies you about each borrower’s eSigning activity. You can identify the borrower in question using the provided borrower_uuid in the message. This enables you to provide relevant updates to each borrower so they can proceed to their next steps.

📘

The borrower.esigning_completed event does not have the 'borrower_uuid' in the message since it is broadcasted after all borrower's have esigned.

Esigning Reminders

Subscribe to the borrower.esign_reminder event so you are informed when you need to notify the borrower to complete their eSigning. This occurs in the following cases:

• The borrower has yet to eSign and their notary appointment is 3 hours way
• Someone, for example, a Loan Officer, clicks the “remind borrower” button on the Snapdocs interface to send a reminder notification to the borrower to complete their eSigning

Constructing the Esign Access Link

Call the Get a list of Borrower Document Statuses to retrieve a unique access_token to construct a URL that directs the borrower to eSign their documents.

After retrieving the access_token, plug it into the URLs below to create an eSigning link.

Demo Environment
https://app.cs-demo0.snpd.io/secure_access?secure_token=<access_token>&act=preview&redirect_url=<POS dashboard URL>

Production Environment
https://app.snapdocs.com/secure_access?secure_token=<access_token>&act=preview&redirect_url=<POS dashboard URL>

Redirect the Borrower to your Dashboard
The &redirect_url=<POS dashboard URL> at the end of the URL brings the borrower back to your dashboard, or any other desired page upon completing their eSigning. Clicking the back button in the upper left hand corner of the eSigning screen will send them to the redirect_url provided and log them out of Snapdocs.