During verification, we may send you several types of webhooks, such as user verification webhooks and transaction monitoring webhooks. Make sure to check the
applicantReviewed webhook described in the Receive and interpret results via API section.
For production mode, it is required to configure a webhook endpoint that we would call when necessary — we need a webhook URL from you where we can send your results. At least the
applicantReviewedwebhook must be configured.
- We may send several final webhooks, so be prepared to change the applicant status on your side accordingly. A typical example is when an applicant got approved, but later on they were detected as a fraudster, and therefore we block them with a second
REDwebhook. For more information about rejection, see this article.
- On sandbox mode, checks will not be started automatically, which means webhooks will not be sent. You can request us to start the process manually, or trigger the webhook yourself. Once the integration is complete and you have moved to the production environment, the webhooks will be sent automatically once verification is completed.
If you want to manually check the applicant status, use this API method. However, we do not recommend using polling as a base method for getting verification results, but rather strongly encourage the webhook mechanism.
If, for some reason, you missed the webhooks, do not worry — we make a note of everything that was attempted to be sent, and can resend failed webhooks at any point in time. If the webhook request fails, we attempt to resend it four times — after 5 minutes, 1 hour, 5 and 18 hours until request succeeds. Check the
createdAt field of the webhook payload to make sure that you are getting relevant applicant status.
You can monitor webhook statuses and resend them manually on the API Health page.
Updated 5 days ago