Version 1

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