API Reference
API Reference
Vida offers a collection of API's for identity verification, which enables the verification of user information and the retrieval of verification status and results. Additionally, it provides the possibility to configure webhook to receive real-time updates on the status of the verification process.
To ensure the security and integrity of API calls, an authentication process is implemented.
Authentication
In order to make API requests, partners need to include an "authorisation header" in each request they make. This header should contain a unique "bearer access token", which serves as a form of authentication.
Perform Identity Verification
The Identity Verification API allows partners to confirm the identity of their users by sending their details and the information that needs to be verified. The API performs checks and validations, such as comparing the information against government records and performing facial recognition analysis. Upon completion, the API returns a transaction ID and the outcome of the verification,
Status Check
This API allows partners to keep track of their identity verification requests. You simply need to input the transaction ID that was returned when you made the request and the API will give you the current status of that verification request. It will provide information such as the verification status, codes, and reasons for any failures.
Identity Verification Data
The Data API gives partners access to all the information collected during the identity verification process, such as the user's name, date of birth, Identity verification status, and any scores generated. This API is only available after a successful response from the identity verification API.
Webhook
The Webhook API helps partners stay updated on any changes to their identity verification transactions. Whenever there is an update, VIDA will send a JSON request to the partner's API. To receive these updates, the partner's API must be able to accept the webhook URL, authentication method (OAuth2-based client credentials or Basic Auth), and credentials provided by VIDA.
The partner can also check the status of the request through the identity verification status check API
Last updated