Webhook Setup
Guide to setup a webhook for EKYC & AML
Last updated
Guide to setup a webhook for EKYC & AML
Last updated
Webhook Configuration Fields
Webhook Name: This field allows you to specify a custom name for your webhook, making it easily identifiable in your system.
Webhook URL: The endpoint URL of your server where the webhook data will be sent. Ensure this URL is accessible and can process incoming data. The URL must support the required HTTP method (e.g., POST).
Webhook HTTP Method: Specifies the HTTP method the webhook will use to send data. The most commonly used method is POST, which sends data in the body of the request. Ensure that your server is set up to accept this method.
Headers (Key-Value Pairs): Custom headers that can be added to the webhook request. These headers can include authorization tokens, content type, or any other information necessary to authenticate or process the webhook on your server. Example:
Authorization: mysecret
Content-Type: application/json
Webhook Usage
Once the webhook is configured, it will receive notifications for the following scenarios:
eKYC Response: After the eKYC verification process is completed, the webhook will receive a response containing the final status and details of the verification. This enables your system to act upon successful verification or handle failures accordingly.
eKYC Status Updates: Any changes or updates to the eKYC process (e.g., a status change from "pending" to "approved" or "rejected") will trigger a webhook notification. This keeps your system informed of real-time status changes.
AML Ongoing Monitoring Updates: If there are any updates related to ongoing AML monitoring (e.g., detection of suspicious activity or an alert on a monitored case), the webhook will be notified. This ensures that your system stays up-to-date with potential AML-related issues.
Sample EKYC response