How can I configure and understand Veriff's Decision Webhooks?
Webhooks are an integral part of Veriff’s verification process. They allow the system to send verification results, including decisions, verified data, and session details, directly to a predefined URL. Below is an overview of Veriff’s Decision Webhooks, their configurations, and the relevant details to help you better understand and utilize them.
Introduction to Veriff's Decision Webhooks
Veriff’s Decision Webhooks streamline the process of delivering verification results. After a decision is reached, the webhook sends out a decision, optionally including details such as:
Verification status and timestamps
Personal and document details
Additional features like risk scores or biometric outcomes (depending on custom configurations)
In cases where resubmission is required, the system allows users a five-minute window to resubmit. If this window lapses without a resubmission, a separate resubmission webhook is triggered. You can configure the endpoint URL for these webhooks in the Veriff Customer Portal.
Basic Configuration and Flow
To configure your webhook:
Log into the Veriff Customer Portal.
Specify the endpoint URL where webhook responses should be sent.
Refer to the official Decision Webhook documentation for sample requests and property explanations: Decision Webhook Documentation.
The typical flow includes the following steps:
A verification session is initiated.
Once a decision is reached, the webhook sends a payload to the specified URL immediately, unless in resubmission scenarios.
Plan-Specific Features and Parameters
Essential Plan Users:
The Self-Serve Essential plan operates using Full Auto webhooks. Differences include automated verification handling without manual involvement. Full Auto webhook-specific documentation includes:
General Details:
For other plans, consult external links provided in the Decision Webhook page, where explanations and examples are outlined depending on your configurations and needs.
Frequently Queried Fields in Webhooks
'DriversLicenseCategory' and 'Document Sub-Type':
Users often inquire about fields such as 'driversLicenseCategory' or 'Document Sub-Type.' These data points appear in webhook responses when configured. To locate and interpret these fields, consult Veriff's documentation:
Decision Status:
This key attribute provides insight into whether a verification is approved, declined, or requires additional input. Timestamps and relevant metadata help pinpoint where the decision was made within the verification process.
Further Resources
For additional information:
By understanding these configurations, you can make the most of Veriff’s Decision Webhooks and seamlessly integrate them into your workflows.