Introducing VIDA Identity Stack: All of VIDA, in one place 🎉
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Change Logs

This document logs all modifications made to the Identity Verification APIs, keeping our partners informed of the most recent version. It serves as a record of updates and revisions.

Version 5.1 05 June 2025

Changes

Added manual review scenario

Version 5 08 Sept 2023

Changes

  • Release new API version 3

Updated the response section for Identity verification response and kycData Api response. The result will now contain only certificateIssued that can help to determine the Identity verification and certificate issuance status Field “kycEventId” is changed into “eventId”

Version 4 18 Aug 2023

Changes

  • Release new API version 2

Update the responses for FR and demographic validation result to be TRUE/FALSE/RECHECK instead of scores

Version 3.5 06 Jan 2023

Changes Added Liveness enhancement

Version 3.4 30 Nov 2022

Changes

  • Moved the ConsentedAt parameter from optional parameter table to mandatory parameter table under the Introduction > Identity verification API > Identity verification data API > Request body

  • Added hyperlink to the E.164 format for mobile number parameter under the Introduction > Identity verification API > Identity verification data API > Request body

Version 3.3 25 Nov 2022

Changes

  • Added detailed reason of face match score -100.0 under Introduction > Identity verification API > Identity verification data API > Response body

  • Added mock data for extended-demographic parameters under Mock data for testing

  • Error code 4004 is removed from the document.

Version 3.2 18 Nov 2022

Changes

  • Moved the Identity verification status code and transaction webhook tables from the HTTP 200 OK response to response body section.

  • Changed the selfie liveness error webhook response from status code 3 to status code 5

Version 3.1 14 Nov 2022

Changes

  • Added mock data for newly added error codes under mock data for testing section.

  • Added the following flow diagrams under the Introduction section.

  • Flow diagram: Successful verification

  • Flow diagram: Error during verification

  • Flow diagram: Status code visualization

Version 3.0 11 Nov 2022

Changes

  • Removed supported parameters and allowed parameters.

  • Added new error codes and revised a few existing error codes under the following section. Identity verification API > Perform identity verification. Identity verification API > Identity verification status. Identity verification API > Identity verification transaction webhook.

  • Added Identity verification data API under Identity verification API section.

  • Added Introduction section.

Version 2.6 31 Oct 2022

Changes

  • Added additional details under selfie photo score.

  • Added additional details under liveness score.

  • Removed the liveness configuration details to avoid confusion.

  • Added selfie image specification in selfiePhotoparameter under Identity verification API > Request body table.

  • Added supported parameter and allowed parameter description.

Version 2.5 11 Oct 2022

Changes

Added status check API & transaction webhook section.

Version 2.4 05 Oct 2022

Changes

Updated the API error codes in the identity verification API response.

Version 2.3 27 Sept 2022

Changes

Updated the API error codes in the identity verification API response.

Version 2.2 16 Sept 2022

Changes

Updated VIDA API call flow diagram under Fundamental section.

Version 2.1 15 Sept 2022

Changes

Updated error codes for face verification API and authentication method

Version 2.0 25 Aug 2022

Changes

New API workflow added

Version 1.2 16 Aug 2022

Changes

Initial release

Last updated