API Reference

Website Example

💻 IDKit integration with your website.

You can effortlessly integrate IDKit with your website by sending the verification link to your users via SMS. Once they complete the verification, you will retrieve the verification report on your ecosystem! ✨

📘

Note:

  • To call the API, you will require an access token, please refer to this page for the tutorial.
  • For more information on the create a transaction endpoint, take a look at this page.
  • This page explains how to make an API call.

Overall Process

  1. Call the Create a Transaction endpoint with a webhook URL embedded in the request.

  2. The API request will return a unique URL verification link, which can be sent to the user via a text message.

  3. When the user clicks on the link, it will redirect them to the IDKit verification process.

  1. After completing the verification, whether they have successfully verified themselves or failed, the user will be redirected to the link defined in the redirect_url_success.

  2. As an example defined below, when the user succeeds in the verification, it will redirect the user to YouTube.

  1. After the verification is done, you can retrieve all the verification details and its results.

📘

Note:

Refer to Fetch a Transaction - JSON - Response to understand the verification results.

  1. Finally, yet importantly, the user's verification result will be sent back to the client ecosystem.

💬 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.