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.

API Reference

VIDA’s Selfie ID APIs enable biometric authentication by capturing and validating a user’s facial features. Unlike FaceMatch, Selfie ID involves creating and validating a reusable facial recognition credential (Credential ID).

API Name

Description

Method

Link

Transaction Initiation

Initiates FaceID authentication and returns session ID, bearer token, URI

GET

Selfie ID - Follow-up

Responds to challenge with image / reference (KYC event ID, liveness ID)

POST

Transaction Completion

Completes authentication by validating image against provisioned template

POST

Transaction Management API

Transaction Status API

Used to request the status of an ongoing authentication or provisioning transaction. This API is useful for monitoring the transaction progress and determining the next steps.

Transaction Kill API

Used to terminate an ongoing authentication or provisioning transaction. This may be necessary in various situations, such as user requests, or process errors.

For a detailed understanding of how these APIs work, you can refer to the specific sections about each of these APIs.

Last updated