Verifying a Complete Transaction

There are two methods to tell when a user has completed their ID verification.

Method 1: Webhook Notification.

A webhook notification is a message that alerts a user of the newest event. In IDKit, once the transaction is considered closed, we send a notification to your endpoint with the transaction_id so you can retrieve the results.

You need to pass the connection details via the notifications object when creating the transaction:

auth_header_name and auth_header_value will be used to define an authentication header sent with the notification. They are both optional.

Currently, the only supported event is complete and the only supported type is HTTPS.

👍

Info:

Your webhook endpoint must return a 200 OK response upon successful delivery of the notification.

Method 2: Redirect and Poll

In the Post- Create a transaction API request, you can specify a redirect_success_url so that once a user completes, we can redirect them to that URL.

Below is an overview of how we are going to redirect to the success URL defined before:

📘

Note:

For customisation options for this screen, please refer to the documentation here.

Once the user has accessed your given URL, you can poll the Get- Get the Transaction endpoint until the overall status is Complete.

📘

Note:

Polling is required because we redirect the user before the results are ready. It typically takes less than 30 seconds for a transaction to complete.

💬 We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.