Transaction Completion

In the authentication phase, the user presents their face for verification, and the API compares this against the stored template for validation. The process is initiated by an API call, which responds with a session ID, bearer token, and a challenge. The user then responds to this challenge by submitting a selfie.

The authentication process can follow one of three options based on the selected preference. The following types of parameters can be passed to the API:

• Using KYC Event ID : kyc_event_id obtained during the KYC process can be included part of the request.

• Using Liveness Transaction ID: The liveliness_transaction_id, obtained during the liveness verification process, can be included as part of the request

• Using Template URL: The partner can provide the URL of the template image (template_url), which represents the user-selfie.

• Using Image: User selfie image can be submitted as a Base64 encoded string

Authentication Preferences

Preference	KYC Event ID	Liveness Transaction ID	Template URL	Image
Required Params	kyc_event_id	liveliness_transaction_id	template_url	image (Base64)
Preference	First	Second	Third	Fourth
User Verification	User’s verification is done by VIDA, and the image from the same verification is used for authentication.	User’s liveliness has been done by VIDA’s product (liveness service or SDK) and transactionId from same is being used for authentication	User is verified by partner	User is verified by partner
Business Use Case	When partners are using KYC solution provided by VIDA.	When partner don’t want to perform liveliness again. For avoiding duplicate liveness check and reducing network latency	When partners don’t have any KYC prior integration with VIDA.	When partners don’t have any KYC prior integration with VIDA.
Liveness During Provisioning	NO	NO	YES	YES
User Attributes stored during provisioning	kyc_event_id credential_id	templateLivelinessTransactionId credential_id	credential_id liveliness related details (trxId, livelinessScore, imgManipulation Score, code, message)	credential_id liveliness related details (trxId, livelinessScore, imgManipulation Score, code, message)
Image Storage	Image fetched based on kyc_event_id is stored.	Image fetched from the based on liveliness_transaction_id is being stored	Image downloaded with the help of template_url.	Image supplied by partner in image parameter is stored.

Selfie ID Followup - API Description

Method : POST

URL : Follow up url received as part of the response of the Transaction Initiation API

Headers

Name	Type	Description
Authentication*	String	Bearer {Bearer Token Received in Transaction Initiation API}
Content-Type	String	application/x-www-form-urlencoded

Parameters

Using KYC Event ID

Name	Type	Description
client_id*	String	A unique client id that is shared for each partner
kyc_event_id*	String	Obtained during the KYC process

Using Liveness Transaction ID

Name	Type	Description
client_id*	String	A unique client id that is shared for each partner
liveliness_transaction_id*	String	The liveliness verification transaction id received as part of the Vida Liveliness verification process (e.g. Vida Liveliness SDK)

Using Template URL

Name	Type	Description
client_id*	String	A unique client id that is shared for each partner
template_url*	String	template image url which represents the user-selfie

Using Image

Name	Type	Description
client_id*	String	A unique client id that is shared for each partner
image*	base64 string	Selfie Image of the user as Base 64

200: OK

{
    "entity": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJYbnNBNFVPdlkyU0JLSkdnX1ppTHN1Tk8tZ2dlLVB0RXZzX2twRTBhd3RnIn0.eyJleHAiOjE3MDM1ODE5NzUsIm5iZiI6MTcwMzU4MTY3NSwiaWF0IjoxNzAzNTgxNjc1LCJhdXRoX3RpbWUiOjE3MDM1ODE2NzUsImp0aSI6IjQwODczODM2LWRkNDAtNDI0NS1iNzYwLTQ4ZjgxYTRmMzg4ZiIsImlzcyI6Imh0dHBzOi8va2V5Y2xvYWsuYXV0aC1zdGFnZS52aWRhLmlkL3JlYWxtcy9zcHJpbmdib290LXF1aWNrc3RhcnQiLCJzdWIiOiJlY2FiYzIzYS1iYThlLTQ3ZGUtYjdhNy1iZDlkZGYzZTAxNzEiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJhcGkiLCJzZXNzaW9uX3N0YXRlIjoiZWZjNmM4OGItYTIyZC00ZWFmLTgyY2MtOTg0MGViYzNlMDA0Iiwic2NvcGUiOiIiLCJzaWQiOiJlZmM2Yzg4Yi1hMjJkLTRlYWYtODJjYy05ODQwZWJjM2UwMDQiLCJreWNfZXZlbnRfaWQiOiI4MjljODM3Zi01YmFjLTQ4YWYtYTViZC0zNDk5NTFjYzM2NDgiLCJsaXZlbGluZXNzVHJhbnNjYXRpb25JZCI6IjIwMjAwNjk0LTNiYzgtNDg4OS05MTIzLWM2OTI2ZDA5MGRhYSIsImZhY2VNYXRjaE1lc3NhZ2UiOiJTZWxmaWUgcGhvdG8gbWF0Y2hlcyB3aXRoIHJlZmVyZW5jZSBwaG90byIsImZhY2VNYXRjaFNjb3JlIjoiMS4wIiwibGl2ZWxpbmVzc1Njb3JlIjoiMC4wMDYzNzYiLCJtb2JpbGUiOiI4MjljODM3Zi01YmFjLTQ4YWYtYTViZC0zNDk5NTFjYzM2NDgiLCJzZXNzaW9uX2lkZW50aWZpZXIiOiJJYmdwYkdpLXdpYyIsInR5cGUiOiJGYWNlSUQiLCJsaXZlbGluZXNzQ29kZSI6IjEwNDMiLCJsaXZlbGluZXNzTWVzc2FnZSI6IlNlbGZpZSBwaG90byBpcyBhIGxpdmUgcGhvdG8iLCJmYWNlTWF0Y2hUcmFuc2NhdGlvbklkIjoiZDE0YjFlNzEtNDU3Yy00OTdjLTgwMTEtNzQwMGZiZjE1YjVjIiwiY3JlZGVudGlhbF9pZCI6ImJiZGNiMjg0LWE2NGMtNGMwYy04ODljLWMxMDBlMDk1NmZmZiJ9.UWzIn_E4u_OUcv9q4vLfeYCfkzdv6T11es-7zEX1oZxeFPbMZUR8Clj_5pEKLZTJmD01Dcdgm2FBU-4WvX9p3QmMI6pqkvQvDZilzFGkaKFYmZBI8VT9GmtD96OfRWQAtwUEiVbf_6pFHujHHMiydlndGoL9tm87nuMd9HwKD42Msejq4IdPNDUbnVhIMrqMaMkTyaE2jYGO1OzgZWm-InKXXV1_IuaXaZaIh2A2AfL2FDbyxTzRHFfd4BI5buSR03HUz_yw2hAwwHvXyojjU2MLYc76pQYfN38nUEhJLb6pGnbD01NRLIaiGQKQtYqKd8SmKjC2tOnXpsfj1WIpfA",
        "accessExpiresIn": 300,
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmMjFhZGYyZS03NWU2LTQ5Y2UtOWYwZi00ZDEwNjE0MDA4NGEifQ.eyJleHAiOjE3MDM1ODM0NzUsImlhdCI6MTcwMzU4MTY3NSwianRpIjoiMDI5OTExNmMtMGY2OS00NjEyLTgyZTYtNzdiMzIwM2I3NDNlIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5hdXRoLXN0YWdlLnZpZGEuaWQvcmVhbG1zL3NwcmluZ2Jvb3QtcXVpY2tzdGFydCIsImF1ZCI6Imh0dHBzOi8va2V5Y2xvYWsuYXV0aC1zdGFnZS52aWRhLmlkL3JlYWxtcy9zcHJpbmdib290LXF1aWNrc3RhcnQiLCJzdWIiOiJlY2FiYzIzYS1iYThlLTQ3ZGUtYjdhNy1iZDlkZGYzZTAxNzEiLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoiYXBpIiwic2Vzc2lvbl9zdGF0ZSI6ImVmYzZjODhiLWEyMmQtNGVhZi04MmNjLTk4NDBlYmMzZTAwNCIsInNjb3BlIjoiIiwic2lkIjoiZWZjNmM4OGItYTIyZC00ZWFmLTgyY2MtOTg0MGViYzNlMDA0In0.XGkS03_dTcVCA2hwYfN-6BI1AmdoJEYIORE_i4-wD2w",
        "refreshExpiresIn": 1800,
        "authType": "FaceID"
    },
    "uri": "https://{environment-url}/realms/{partner-id}/protocol/api/authenticate",
    "bearerToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlZmM2Yzg4Yi1hMjJkLTRlYWYtODJjYy05ODQwZWJjM2UwMDQiLCJleGVjdXRpb24iOm51bGwsInRhYl9pZCI6IkliZ3BiR2ktd2ljIiwibmJmIjoxNzAzNTgxNjc1LCJzZXNzaW9uX2NvZGUiOiJSRFpLVXFId1oxeHZseTFnYm8ySkhIblVMUkk4VEV5VjM3SVFPM0ZsTEdzIiwic2Vzc2lvbl9pZGVudGlmaWVyIjoiSWJncGJHaS13aWMiLCJleHAiOjE3MDM1ODE5NzUsImlhdCI6MTcwMzU4MTY3NSwiYXV0aF9zZXNzaW9uX2lkIjoiZWZjNmM4OGItYTIyZC00ZWFmLTgyY2MtOTg0MGViYzNlMDA0IiwianRpIjoiYmZkYmI4ZGUtZjY5MC00OWZlLWEwYjAtNzYxNjMyOGU2NDI2In0.t7hWqOupNrB_a7EMhLfthxCRfK-hDf35x09FPJFWnj0",
    "authType": "FaceID"
}

Curl

curl --location --request POST '{{FOLLOW UP URI RECEIVED AS PART OF THE RESPONSE OF THE TRANSACTION INITIATION REQUEST}}' \
--header 'Authorization: Bearer <Bearer Token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'image=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0CAMAAAD8CC+4+ipPLnhsiBY4oRVTogCWPuy71gAg5NUdg8J/wvc/wBDUDohi1/pvwAAAABJRU5ErkJggg==' \
--data-urlencode 'client_id=api'

{
    "uri": "{URI OF THE FOLLOW UP REQUEST FOR TRANSACTION COMPLETION}",
    "bearerToken": "{BEARER TOKEN TO BE ADDED IN AUTHORIZATION HEADER OF FOLLOW UP REQUEST}",
    "authType": "{AUTHENTICATION TYPE}",
}

Error Response

{
    "error": "Unprocessable Entity",
    "errorDescription": "message=Unprocessable Entity;livelinessScore=0.0;faceMatchScore=0.0"
}

Response Schema

{
    "error": "{TYPE OF ERROR}",
    "errorDescription": "{REASONING FOR THE ERROR}"
}