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
callback_url: Sends a single webhook notification when the verification run is complete.
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:
Set up both
callback_urlandevents_callback_urlin your integration.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:
callback_url: Receives a verification result payload. For details, see the Verification Result documentation.events_callback_url: Receives various event payloads. For a full list of events and their payloads, refer to the Events Callback documentation.
Manual Approvals
When a user doesn't pass the automated KYC validation and you manually approve the verification:
The
callback_urlwebhook will not be triggered again, as it only fires once per session.The
events_callback_urlwebhook 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.