Webhook¶
vali-Das can provide a webhook that sends real-time notifications whenever a validation changes status within our product. When a validation's status changes, a notification is sent to the URL specified by the client with relevant data.
Webhook Server Requirements¶
When setting up a webhook endpoint, it's crucial to ensure that your server is properly secured. To do so, it should meet the requirements hereunder.
- Webhook URL: Ensure you provide a valid URL to receive the webhook notifications.
- HTTPS Protocol: To ensure a secure and encrypted connection between our system and the customer's system, the URL provided shall use the HTTPS protocol.
- OAuth Authentication: The URL shall be protected by an OAuth authentication mechanism. This verifies the identity of the webhook sender and ensures that only our system can send requests to that URL.
- Availability: The URL shall be available and accessible at all times to ensure timely delivery of webhooks.
- Supported Formats: JSON.
Possible validation status¶
| Status | Description |
|---|---|
| on-course | validation has been created |
| document-uploaded | validation has Score-DocumentGlobal score |
| documen2-uploaded | validation has Score-DocumentGlobal score |
| document3-uploaded | validation has Score-DocumentGlobal score |
| selfie-uploaded | validation has ValidasScoreSelfie |
| video-uploaded | validation has ValidasScoreVideo |
| cancelled | validation cancelled with PUT /validation/ |
| confirmed | validation confirmed with PUT /validation/ |
| deleted | validation deleted with DELETE /validation/ |
Webhook Server API¶
Leveraging vali-Das API¶
Consider exploring the endpoints explained in the API section of vali-Das documentation to automate webhook requests and verify responses. You will find information on the following:
- How to query all status change events.
- How to filter for events where the webhook notification was not sent successfully or not.
- How to query a specific event.
- How to filter for validations where the webhook notification was not sent successfully or not.
- How to get all events for a specific validation
Please read carefully
- Prior to using the functionality, Veridas must be notified of the URLs that will be configured for the webhooks to enable whitelisting and ensure proper notification delivery.
- In order for the event endpoints to work, the Webhook must be enabled and working. Check out
POST /test endpointavailable to check if the webhook is properly set up.