API Integration

1- How to Integrate Our TethysFaceid gateway with your Project:

Steps to follow..
1. Contact Our Team to be provided your Secret and Licence Key

2. Add the following button as Face ID request event:


 <button id="myButton" type="button">Tethys Auth</button>

<script type="text/javascript">
 document.getElementById("myButton").onclick = function ()
 {
 location.href ="https://tethysfaceid.com/?access_key=acc_key&license_key=licence_key";
 };
 </script>

3. Pass the access_key and licence in the url parameters as below
https://tethysfaceid.com/?access_key=9a23ad06e00c048f4aebfbcf7d1928acc&li cense_key=001-593-3147

2- Facecompare Api’s Details:

Url: /facecompare

Api endpoint:
https://meza8z760k.execute-api.us-east-2.amazonaws.com/default/facecompare

Request Type: Post

CORS : Cors enabled from the backend for the browser support

Use:

This API exposes the user to a biometric match, the user will upload a live picture which will be analyzed against the biometric records in the database. The liveness process helps verify the identity of the user at time of submission. An error response will be returned if the biometric do not match.

3- FaceCompare Api Request Structure:

This Api takes the following parameters in its request Header
● licence: licence key provided by our team.
● access_key: access_key provided by our team.

This Api takes the following parameters in its request body

● id: userId of the user
● username: tehtys username
● picture : encrypted image used for comparison with the users image

Request Header:


{
"licence":"licence key",
"access_key":"access key",
}

Request Body:


{
"id":"512dde8a-56f4-4a25-8430-29cd787fa982",
"username":"username",
"picture":"base64Image",
}

4 - FaceCompare Api Response Structure:

Response Body:
● similarity: boolean
if the user image( sent in URL matches with the database image then the value
shown will be true otherwise false
● id: userId of the user
● username: tethys username
● message: message according to Failure or Success

1. If all the parameters sent in the post requests are valid then the response body will
be as follows :


{
"Similarity":true,
"username":"test",
"id":"512dde8a-56f4-4a25-8430-29cd787fa982",
"message":"Successfully Verified Face Authentication.",
}

2. If licence and access key are not valid then response body will show this:


{
"message":"Unauthorized User"
}

3. Incase of username or ID is not valide


{
"message":"Invalid ID or UserName"
}

5 - Demo App For the Tethys Face ID App:

We also have demo app for Tethys Face ID with the

https://www.tethyswebapp.ml/domain name.

You can directly check our web app with the below link

https://www.tethyswebapp.ml/?access_key=9a23ad06e00c048f4aebfbcf7d1928acc&
license_key=001-593-3147