Versions

Recommended/Latest version is always placed at the top of the page. (v2 for OkayFace)

1:1 Face Verification V2

1:1 Face Verification V2

POST http://demo.faceid.asia/api/faceid/v2/verify

Headers

Name	Type	Description
livenessMeta	String	The JSON string with device information

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	object	Front id card image
imageBest *	object	Image that's used to compare with imageIdCard

200 Response without liveness checking

{
    "request_id": "1491401591,b0398182-ca04-4f7e-b59a-7c83398cf230",
    "result_idcard": {
        "confidence": 96.46025
    }
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

525B

OkayFace V2.postman_collection.rar

OkayFace V2

1:1 Face Verification V3(Deprecated)

1:1 Face Verification V3

POST http://demo.faceid.asia/api/faceid/v3/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	object	Front id card image
imageBest *	string	Encrypted string for liveness face retrieved via liveness SDK

200 Response without liveness checking

{
    "request_id": "1491401591,b0398182-ca04-4f7e-b59a-7c83398cf230",
    "result_idcard": {
        "confidence": 96.46025
    }
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

532B

OkayFace v3.postman_collection.rar

OkayFace V3

1:1 Face Verification V4(Deprecated)

1:1 Face Verification V4

POST http://demo.faceid.asia/api/faceid/v4/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	string	Front id card image in base64
imageBest *	string	Image in base64 that's used to compare with imageIdCard

200

{"request_id":"8fa0cdcf-5f50-4671-8db1-47145232d200","result_idcard":{"confidence":0.51890767}}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

572B

OkayFace v4.postman_collection.rar

OkayFace V4

1:1 Face Verification V2-1

1:1 Face Verification With Liveness Detection (Encrypted string is not required)

POST http://demo.faceid.asia/api/faceid/v2-1/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	object	Front id card image
imageBest *	object	Selfie photo

200

{
"imageBestLiveness":
    {
        "probability":2.492201929271687E-7,
        "score":-5.0898823738098145,
        "quality":1.0
    },
"request_id":"TASKAI208003201910300952440191412201",
"result_idcard":
    {
        "confidence":57.86325
    }
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

570B

OkayFace v2-1.postman_collection.rar

OkayFace v2-1

1:1 Face Verification V2-2

1:1 Face Verification With Liveness Detection

POST http://demo.faceid.asia/api/faceid/v2-2/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	string	Front id card image in base64
imageBest *	string	Selfie photo in base64

200

{"imageBestLiveness":{"probability":1.8339830987201822E-8,"score":-6.1092305183410645,"quality":1.0},"request_id":"53b7443b-2cf9-407e-a710-b304a6a569a5","result_idcard":{"confidence":{"imageBestLiveness":{"probability":0.03970755,"score":-3.1856966,"quality":0.7613958},"request_id":"1588554351758433I8E5268147307508","result_idcard":{"confidence":59.11985}}}}

Postman Collection

578B

OkayFace v2-2.postman_collection.rar

OkayFace v2-2

1:1 Face Verification V3-1(Deprecated)

1:1 Face Verification With Liveness Detection (Encrypted string is required)

POST http://demo.faceid.asia/api/faceid/v3-1/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	object	Front id card image
imageBest *	string	Encrypted string for liveness face retrieved via liveness SDK

200 Response without liveness checking

{"imageBestLiveness":
    {
        "probability":2.492201929271687E-7,
        "score":-5.0898823738098145,
        "quality":1.0
    },
"request_id":"TASKAI208003201910300952440191412201",
"result_idcard":
    {
        "confidence":57.86325
    }
}

Postman Collection

N/A

1:1 Face Verification V4-1(Deprecated)

1:1 Face Verification With Liveness Detection

POST http://demo.faceid.asia/api/faceid/v4-1/verify

Request Body

Name	Type	Description
apiKey *	string	To be assigned by Innov8tif
imageIdCard *	string	Front id card image in base64
imageBest *	string	Selfie photo in base64

200

{"imageBestLiveness":{"probability":1.8339830987201822E-8,"score":-6.1092305183410645,"quality":1.0},"request_id":"53b7443b-2cf9-407e-a710-b304a6a569a5","result_idcard":{"confidence":0.51890767}}

Postman Collection

574B

OkayFace v4-1.postman_collection.rar

OkayFace v4-1

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

Interpretation of Result and Recommended Threshold