Face Comparison (V-Face)

V-Face is used to perform the Facial Verification.

Overview

The user will need to submit a selfie to test on the FR API. The purpose of this API is to compare the facial image on the ID card with the Selfie taken in this API to check if the user is the same as the ID card's owner.

The API also contains "Liveness Detection" to make sure that the selfie is taken by a real person. This will greatly increase the security level of the V-Face API to help counter fake selfie submissions.

This API should be use in conjuction with V-Doc API.

API Method

POST https://onboard.veryfyglobal.com/api/ekyc/v-face

Headers

Key
Value

Accept

application/json

Content-Type

multipart/form-data

Input Sample

Key
Type
Value
Description

reference_id

string

a714fccb-2676-40eb-8696-xxxxxxxxxxxx

The reference key from Create Reference ID API

face

file

Captured selfie image

Response Sample

{
    "message": "Ok",
    "data": {
        "confidence_score": 90.53344,
        "liveness": {
            "probability": 0.6,
            "quality": 0.95810515
        }
    }
}

Image Requirement

It is recommended to use uncompressed formats. If it’s not possible, then use compress image with the highest quality to make sure that the API detection is accurate.

Minimum Resolution

  • 450px x 450px

Maximum File Size

  • 2.5MB

To Avoid

  1. Blurry or motion blur selfie image that will decrease the accuracy of the API.

  2. Overly compressed image that will decrease the accuracy of the API.

  3. Selfie that is taken in landscape mode that will cause detection error.

  4. Environment that is too bright or too dark that cause API fail to pick up the selfie's facial features.

  5. Multiple faces in the background of the selfie.

  6. Facial position that is too near or too far from the selfie image.

To Do

  1. Facing straight to the camera to ensure the API detection is able to detect the facial features accurately.

  2. Retain a portion of margin surrounding the selfie image to prevent API fail to detect face.

  3. Make sure the selfie's head is within the picture frame.

Last updated