Setting up webhooks

The webhook feature allows you to be notified automatically when specific events occur during a consumer's verification process.

Below is a list of the available notifiers you can set up:

1. Eligible - when a verification is approved
2. Document Rejected - when a consumer's uploaded document has been rejected
3. Max Attempts - when a consumer has reached the maximum number of attempts to prove eligibility
4. Reminder to complete verification - when a consumer needs to finish an incomplete request
5. Consolation - when a consumer is found to be ineligible, but is offered a consolation
6. Email Loop - when a consumer is sent an email to verify ownership of their email address
7. Expiration - when a consumer's verification request has expired
8. Error - when an error occurs during the consumer's verification process

How to set up webhooks in MySheerID

1. Login to your MySheerID account
2. Select the Program you want to update
3. Click the Settings button
4. Locate the Webhooks section and click +Add to open the dialog box
5. To enable webhooks you'll need to toggle the switch from Off to On, then input your endpoint URL in the available field
6. Under the list of Verification events, toggle on any of the events that would be beneficial to you and your team
7. Click Save to begin testing and using webhooks

Best practices for when webhooks should fire vary based on the use case desired.

• If you are using webhooks for CRM integration (storing all zero party consumer data), webhooks should be fired upon success, max attempts, and expired verification.
• If you are looking to simply link accounts to a successful verification (account linking reward methodology), webhooks should be fired on success only.
• If you are hosting your own emails, then webhooks should be fired on all emailable events. For information on emailable events, see this article.

Deprecated Webhooks

Those using the older webhook feature will see that some webhook settings are labeled as Deprecated as seen below.

While the deprecated webhook setting is still functional, it will no longer be updated and eventually be phased out of the platform. SheerID recommends disabling the deprecated webhook setting and transitioning to the new webhook feature as soon as possible.

Notes

• The webhook will send a POST message in JSON format. Included in the payload is the verificationId. SheerID never sends consumer personally identifiable information (PII) in a webhook payload.
• You can use the verificationId to retrieve all user and program details about a verification from SheerID's REST APIs.

See the Creating Webhooks Tutorial in SheerID's Developer Center for more information.