Face Query

Query

POST https://okaydocdemo.innov8tif.com/ekyc/api/innov-face/facequery/query

This API enables the querying and match the facial image in database to check for existence

Request Body

Name	Type	Description
apiKey	string	To be assigned by Innov8tif
imageBase64	string	Selfie image or portrait image in base64
imageFile	string	Selfie image or portrait image
groupName	string	Group name that existed in database that matches the facial image

200

{
    "status": "success",
    "resultFound": true,
    "groupFound": true,
    "name": "zhiyan",
    "score": 0.0
}

Input Example in Postman

Query facial image need to fulfill the image requirement for better accuracy

Possible Responses

When image is found in the group (database table)

{
    "status": "success",
    "resultFound": true,
    "groupFound": true,
    "name": "zhiyan",
    "score": 0.0
}

When group does exists but cannot find similar face

{
    "status": "success",
    "resultFound": false,
    "groupFound": true
}

When group does not exist

{
    "status": "success",
    "resultFound": false,
    "groupFound": false
}

When no face detected in image

{
    "status": "error",
    "message": "There is No Face Detected in Image",
    "resultFound": false,
    "groupFound": false
}

Threshold

The score of the successful image found are listed below:

Threshold Value	Description Status
Score > 0.53	Query Pass
Score <= 0.53	Query Fail

The lower the score, the higher the confidence of the Face Search API comparing the face with the database.