Error Lists

This page contains all of the Error Messages of OkayLive

OK response data is always in JSON format. If received code 200, the data has been accepted, however, there can be one of the following error messages:

OkayLive Error Lists

MessageDescription

Failed to decode image

Image format is not supported.

Can't read image from bytes

File is corrupted.

Failed while detecting face

Face detection module failed during processing of image.

Failed to detect face

Face detector can't find faces.

Failed while predict landmarks

Facial landmarks cannot be found.

Failed to convert image

Internal error. Please send raw data to developers for debugging.

Failed to predict result

Internal error. Please send raw data to developers for debugging.

Failed to crop face

Face is too close to camera.

Face image is too small

Face width or height is under 224 pixels.

OkayFace & OkayLive Error Lists

Error MessageError CodeDescriptions

Absolute face size is too small

FACE_TOO_SMALL

Face is too far away from the camera. Please make sure that your face is closer to the camera.

Face is cropped

FACE_CROPPED

Face is partially missing from the frame. Please make sure your face fit into the camera frame or in the center.

Face is occluded

FACE_IS_OCCLUDED

Face is partially blocked by object. Please make sure that your face is free of masks or any other object.

Face is too close to one or more borders

FACE_CLOSE_TO_BORDER

Face is too close or shifted away from the center of the camera. Please make sure that your face is further away and at the center of the camera.

Face is too close to the camera

FACE_TOO_CLOSE

Face is too close to the camera. Please make sure to move your face further away from the camera.

Facial out-of-plane rotation angle is extremely large

FACE_ANGLE_TOO_LARGE

Face is not facing towards the camera. Please adjust your face straight facing the camera.

Failed to detect face

FACE_NOT_FOUND

Face is not detected. Please make sure your face is present in the camera frame.

Interpupillary distance is too small

FACE_TOO_SMALL

Facial area is not big enough for analysis. The distance of the face too far that cause the eye distances too close to each others. Please move closer to the camera.

Relative face size is too small

FACE_TOO_SMALL

Face is too small to be detected. The face size is below the minimum requirement, please make sure the your face is closer to the camera.

Too many faces detected

TOO_MANY_FACES

More than 1 face present in the camera. Please make sure that there is no more than one face present in the camera.

-

PAYLOAD_TOO_LARGE

The image being sent is too large, please make sure that the image is within the requirement image size

MISSING_ARGUMENTS: imageIdCard or imageBest

MISSING_ARGUMENTS: imageIdCard or imageBest

The image parameter is missing. Please make sure the image is submitted when API is called.

Data field is compulsory.

-

Please check your parameter again before calling the API.

Sample Response

File Size too big
{
    "status": "error",
    "message": "PAYLOAD_TOO_LARGE"
}
Face is occluded
{
    "status": "error",
    "message": "FACE_IS_OCCLUDED"
}
Missing data field
{
    "status": "error",
    "message": "Data field is compulsory."
}

Last updated