Error statuses¶

IDLive Face API throws the FaceException, which contains a status field. There are two categories of statuses:

1. Image rejection reasons – The image is rejected when a face on it does not meet the necessary requirements. Returned by checkLiveness and similar functions.

2. General errors – User and system-related errors. Returned throughout the API.

Image rejection reasons¶

FACE_TOO_CLOSE

The face is too close to the camera, i.e. a distance between the face and the horizontal or vertical image borders is too small.

FACE_CLOSE_TO_BORDER

The face is too close to one or more image borders.

FACE_CROPPED

The face is cropped.

FACE_IS_OCCLUDED

There is occlusion of the face. This detection is designed to work with the medical masks that cover nose and mouth, other occlusions are not guaranteed. The occlusion detection has probabilistic nature and may have errors.

FACE_NOT_FOUND

The face detector can't find the face on the image. The face detection has some sensitivity level and may ignore very small faces.

TOO_MANY_FACES

The face detector found more than one face on the image.

FACE_TOO_SMALL

The facial area is not big enough for the analysis. The face can be considered small for several reasons:

• Face size in pixels is too small.
• Interpupillary distance in pixels is too small.
• The difference between the image size and the face size is too large.

FACE_ANGLE_TOO_LARGE

The out-of-plane rotation angle (face pitch and yaw) is too large.

EYES_CLOSED

Eyes were detected as closed.

General errors¶