Centralized OkayFace

OkayFace is used to perform the Facial Verification.

Overview

The user will need to submit a selfie to test on the Centralized OkayFace 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 an option to enable the OkayLive API also known as "Liveness Detection" to make sure that the selfie is taken by a real person. This will greatly increase the security level of the OkayFace API to help counter fake selfie submissions.

Steps:

1. The user will need to re-use the JourneyId again.

2. Place the JourneyId and the content mentioned in the API Method below.

3. Users can choose either Version 1-1 or Version 1 to call the API. (Recommended Version 1-1)

4. After expanding the API method, the user can read the descriptions on each parameter and place the details accordingly following this Example.

5. This Centralized OkayFace API included the integration of Centralized OkayLive, this is why the example shown in step 4 contains the "liveness detection". It also has the option to use it separately by disabling the "liveness detection" parameter.

6. The average processing time takes about 2s to 4s.

Please refer to the "Image Requirement" section to get the best result for each API return

API Method

Centralized OkayFace Version 1-1 (Recommended)

POST https://ekycportaldemo.innov8tif.com/api/ekyc/okayface/v1-1

Headers

Name	Type	Description
livenessMeta	String	The environment the image was taken in. Possible values are IOS, ANDROID, DESKTOP or UNKNOWN (the default). e.g. {"OS":"Desktop"}

Request Body

Name	Type	Description
imageIdCardBase64	string	Uncheck 'imageIdCard' to enable this parameter to be working
imageBestBase64	string	Uncheck 'imageBest' to enable this parameter to be working
livenessDetection	boolean	Set to True - return liveness score
imageIdCard *	object	Face Image from ID card
imageBest *	object	Selfie photo
journeyId*	string	Retrieve from 'Create JourneyID' API

200 Successfully response to the user

Response Code Block

{
    "status": "success",
    "messageCode": "api.success",
    "imageBestLiveness": {
        "probability": 0.9999331,
        "score": 9.612308,
        "quality": 0.6691686
    },
    "request_id": "1591169623008663I8E5268153513648",
    "result_idcard": {
        "confidence": 88.0169
    }
}

400: Bad Request Failed to response to the user

{
    status: "error"
}

500: Internal Server Error Internal Server Error

{
    status: "Internal Server Error"
}

Centralized OkayFace Version 1

POST https://ekycportaldemo.innov8tif.com/api/ekyc/okayface

Request Body

Name	Type	Description
imageIdCardBase64	string	Uncheck 'imageIdCard' to enable this parameter to be working
imageBestBase64	string	Uncheck 'imageBest' to enable this parameter to be working
livenessDetection	boolean	Set to True - return liveness score
imageIdCard *	object	Face Image from ID card
imageBest *	object	Selfie photo
journeyId*	string	Retrieve from 'Create JourneyID' API

200 Successfully responded to user

Response Code Block

{
    "status": "success",
    "messageCode": "api.success",
    "imageBestLiveness": {
        "probability": 0.9999331,
        "score": 9.612308,
        "quality": 0.6691686
    },
    "request_id": "1591169623008663I8E5268153513648",
    "result_idcard": {
        "confidence": 88.0169
    }
}

400: Bad Request Failed to response to user

{
    "status": "error"
}

500: Internal Server Error Internal server error

{
    status:"Internal Server Error"
}

Kindly refer to the page below for the interpretation of the result.

Interpretation of Result and Recommended Threshold

API Header - LivenessMeta

Meta Key	Meta Value	Required
OS	"IOS", "ANDROID" or "DESKTOP" or "UNKOWN"	Optional (Suggested to include for better accuracy)

Input Example (OkayFace Version 1-1)

Input using image file

Input using base64 image string

Users can either choose to activate livenessDetection by ticking the key or deactivate the livenessDetection by un-ticking the key

Postman Collection

Get the Postman Collection https://api2-ekycportal.innov8tif.com/emas-ekyc-portal/postman-collection