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

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
    }
}

{
    status: "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

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
    }
}

{
    "status": "error"
}

{
    status:"Internal Server Error"
}

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

API Header - LivenessMeta

Meta Key

Meta Value

Required

"IOS", "ANDROID" or "DESKTOP" or "UNKOWN"

Optional (Suggested to include for better accuracy)

Input Example (OkayFace Version 1-1)

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

Postman Collection

PreviousVersion 2 (Blacklist Face Search)NextInterpretation of Result and Recommended Threshold

Last updated 6 months ago

Was this helpful?

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