# Error Lists

### General OkayFace Error Lists

| Message                                      | Descriptions                                               |
| -------------------------------------------- | ---------------------------------------------------------- |
| API\_KEY\_EXPIRED                            | Error in processing                                        |
| MAX\_API\_CALL\_EXCEEDED                     | Maximum API call hit                                       |
| INVALID\_API\_KEY                            | Wrong apiKey                                               |
| MISSING\_ARGUMENT                            | Missing apiKey                                             |
| MISSING\_ARGUMENTS: imageIdCard or imageBest | Missing imageIdCard/imageBest                              |
| PAYLOAD\_TOO\_LARGE                          | imageIdCard/imageBest's file size more than 3MB            |
| Photo format error                           | Invalid imageIdCard/imageBest Format(Support：jpg、jpeg、png) |
| FACE\_NOT\_FOUND                             | Invalid imageIdCard/imageBest has no face detected         |

### OkayFace & OkayLive Error Lists

| Error Message                                         | Error Code                                   | Descriptions                                                                                                                                                          |
| ----------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 Responses

{% code title="Face not found in imageBest/imageBestBase64" %}

```
{
    "status": "error",
    "message": "FACE_NOT_FOUND"
}
```

{% endcode %}

{% code title="imageBest or imageIdCard's file size > 3mb" %}

```
{
    "status": "error",
    "message": "PAYLOAD_TOO_LARGE"
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api2-ekycapis.innov8tif.com/okayface/okayface-all/error-lists.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.