Understanding Webhook Callbacks for User Verification

Last updated: September 25, 2024

When performing user verification, it's important to understand the two types of webhook callbacks available and how to configure them properly to receive all necessary notifications.

Types of Webhook Callbacks

  1. callback_url: Sends a single webhook notification when the verification run is complete.

  2. events_callback_url: Sends webhook notifications for all updates to the session, including manual case updates and comments.

Configuring Webhook Callbacks

To ensure you receive all necessary notifications, including those for manually approved verifications:

  1. Set up both callback_url and events_callback_url in your integration.

  2. Configure these URLs either in the template settings page or at the session level. Session-level values will override template-level settings.

Webhook Payloads

The payloads for each callback type differ:

Manual Approvals

When a user doesn't pass the automated KYC validation and you manually approve the verification:

  1. The callback_url webhook will not be triggered again, as it only fires once per session.

  2. The events_callback_url webhook will be triggered, notifying you of the manual approval.

Ensure both callback URLs are properly configured to receive all necessary notifications, including those for manual approvals and other session updates.