# Error List ### General Error | Message | Description | | --------------------------- | --------------------------------------- | | Error in processing. | No parameter sent | | INVALID\_API\_KEY | Missing/Wrong apiKey | | null | Missing base64ImageString/Invalid image | | MISSING\_ARGUMENTS | Missing imageIdCard/imageBest | | Request size exceed 5MB. | Request size more than 5MB | | MAX\_API\_CALL\_EXCEEDED | Maximum API call exceeded | | API\_KEY\_EXPIRED | API Key is expired | | INVALID\_JOURNEY\_ID | JourneyID not found | | ERROR\_IDV\_EXPIRED | IDV account expired | | MISSING\_PARAM\_CRENDENTIAL | Missing Parameters | | USERNAME\_NOT\_EXIST | Username does not exist | | INCORRECT\_PASSWORD | Wrong Password | | MAX\_JOURNEY\_EXCEEDED | Hit Max Journey | | error | Missing base64image or other parameter | ### General Sample Response {% code title="Invalid JourneyID/ Empty JourneyID/ Data purged" %} ``` { "status": "error", "messageCode": null, "message": "INVALID_JOURNEY_ID", "scorecardResult": null } ``` {% endcode %} {% code title="Account expired" %} ``` { "status": "error", "message": "ERROR_IDV_EXPIRED" } ``` {% endcode %} {% code title="Missing username & password" %} ``` { "status": "error", "message": "MISSING_PARAM_CRENDENTIAL" } ``` {% endcode %} {% code title="Invalid username" %} ``` { "status": "error", "message": "USERNAME_NOT_EXIST" } ``` {% endcode %} {% code title="Invalid password" %} ``` { "status": "error", "message": "INCORRECT_PASSWORD" } ``` {% endcode %} {% code title="Hit Max Journey" %} ``` { "status": "error", "message": "MAX_JOURNEY_EXCEEDED" } ``` {% endcode %} ### Centralized OkayID | Message | Description | | ------------------------ | ------------------------------------- | | Internal Server Error | Missing base64ImageString | | UNRECOGNIZED\_IMAGE | Image is not recognized by the system | | BLACK\_LIST\_ID\_NO | Blacklisted ID No is detected | | DOCUMENT\_NOT\_SUPPORTED | Submitted ID is not supported | ### Centralized OkayID Sample Response {% code title="Missing base64ImageString" %} ``` { "timestamp": "2020-12-28T09:41:52.223+0000", "status": 500, "error": "Internal Server Error", "message": "No message available", "path": "/api/ekyc/okayid" } ``` {% endcode %} {% code title="Image not recognized by the system" %} ``` { "status": "error", "message": "UNRECOGNIZED_IMAGE" } ``` {% endcode %} {% code title="Blacklisted ID No is detected" %} ``` { "status": "error", "message": "BLACK_LIST_ID_NO" } ``` {% endcode %} ### Centralized OkayFace | Message | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | UNEXPECTED\_ERROR | System fail to process the face verification | | UNRECOGNIZED\_IMAGE | Image is not recognized by the system | | UNRESOLVED\_PIC\_CONTENT | Invalid imageBest/imageBestBase64 | | FACE\_NOT\_FOUND | Face not found in imageBest/imageBestBase64 | | PAYLOAD\_TOO\_LARGE | imageBest or imageIdCard's file size > 3mb | | FACE\_ANGLE\_TOO\_LARGE | Facial out-of-plane rotation angle is extremely large | | TOO\_MANY\_FACES | Face detector found more than one face on image | | FACE\_IS\_OCCLUDED | There is occlusion on the face or it is difficult to see the face. e.g. person with a mask, sunglasses and etc. | | 🆕ID\_FACE\_IS\_OCCLUDED *(Only available in UAT now)* | There is occlusion on the ID face or it is difficult to see the face. e.g. random object placed on the ID card | | ERROR\_IMAGE\_ATTACK\_DETECTED | Detect AI-generated and digitally manipulated images (e.g. **AI Faceswap, AI Synthetics, Digitally manipulated images, DeepFake Images)** | ### Centralized OkayFace Sample Response {% code title="Missing imageIdCardBase64 & imageBestBase64 " %} ``` { "status": "error" } ``` {% endcode %} {% code title="Invalid imageBest/imageBestBase64" %} ``` { "status": "error", "message": "FACE_IS_OCCLUDED" } ``` {% endcode %} {% 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 %} ### Centralized OkayFace Plus | Message | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | UNEXPECTED\_ERROR |
  1. Timeout connecting to OkayFace
  2. Timeout connecting to server
  3. Connecting to an invalid server API
| | INVALID\_API\_KEY |
  1. Empty API Key
  2. Invalid API Key
| | API\_KEY\_EXPIRED | Expired API Key | | MAX\_API\_CALL\_EXCEEDED | API Key exceeded limit | | MISSING\_ARGUMENT |
  1. Empty "imageBest" data
  2. Empty "imageIdCard" data
  3. Empty "mobileSdkOutput" data
| | UNEXPECTED\_ERROR |
  1. Invalid "imageBest" data i.e. a non-image type file was uploaded
  2. Invalid "imageIdCard" data i.e. a non-image type file was uploaded
| | INVALID\_MOBILE\_SDK\_OUTPUT | Invalid "mobileSdkOutput" i.e. a non-SDK Output file was uploaded | | FACE\_NOT\_FOUND | Face is not found in either "imageBest" or "imageIdCard" | | FACE\_IS\_OCCLUDED | Face is occluded in either "imageBest" or "imageIdCard" | ### Centralized OkayFace Plus Sample Response {% code title="Timeout connecting to OkayFace Timeout connecting to server Connecting to an invalid server API" %} ``` { "error": "UNEXPECTED_ERROR" } ``` {% endcode %} {% code title="Empty API Key Invalid API Key" %} ``` { "error": "INVALID_API_KEY" } ``` {% endcode %} {% code title="Expired API Key" %} ``` { "error": "API_KEY_EXPIRED" } ``` {% endcode %} {% code title="API Key exceeded limit" %} ``` { "error": "MAX_API_CALL_EXCEEDED" } ``` {% endcode %} {% code title="Empty "imageBest" data Empty "imageIdCard" data Empty "mobileSdkOutput" data" %} ``` { "error": "MISSING_ARGUMENT" } ``` {% endcode %} {% code title="Invalid "imageBest" data Invalid "imageIdCard" data" %} ``` { "error": "UNEXPECTED_ERROR" } ``` {% endcode %} {% code title="Invalid file uploaded for SDK Output file" %} ``` { "error": "INVALID_MOBILE_SDK_OUTPUT" } ``` {% endcode %} {% code title="Face is not found in either "imageBest" or "imageIdCard"" %} ``` { "error": "FACE_NOT_FOUND" } ``` {% endcode %} {% code title="Face is occluded in either "imageBest" or "imageIdCard"" %} ``` { "error": "FACE_IS_OCCLUDED" } ``` {% endcode %} ### Centralized OkayLive | Message | Description | | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Absolute face size is too small | Face is too far away from the camera. Please make sure that your face is closer to the camera. | | Data field is compulsory. | Image is not found | | Face is 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 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 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 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 is not facing towards the camera. Please adjust your face straight facing the camera. | | Failed to detect face | Face is not detected. Please make sure your face is present in the camera frame. | | Interpupillary distance is 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 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 | More than 1 face present in the camera. Please make sure that there is no more than one face present in the camera. | ### Centralized OkayLive Sample Response {% code title="Multiple Faces Detected" %} ``` { "status": "error", "message": "Too many faces detected" } ``` {% endcode %} {% code title="Missing imageIdCardBase64 & imageBestBase64 " %} ``` { "status": "error" } ``` {% endcode %} ### Centralized OkayFace(/api/ekyc/okayface/v1-1 with livenessDetection set True) and OkayLive
ErrorMeaning
FACE_TOO_CLOSEA distance between face and camera is too small for preprocessing issues
FACE_CLOSE_TO_BORDERFace is too close to one or more borders. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_CROPPEDFace is cropped. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_IS_OCCLUDEDThere is occlusion on the face or it is difficult to see face, which degrades the quality of liveness
FACE_NOT_FOUNDFace detector can't find face on image
TOO_MANY_FACESFace detector found more than one face on image
FACE_TOO_SMALLFacial area is not big enough for analysis. Either interpupillary distance(80px) or face size(224 px) is below the configured value.
FACE_ANGLE_TOO_LARGEFacial out-of-plane rotation angle is extremely large
FAILED_TO_PREDICT_LANDMARKSLandmarks prediction error
UNKNOWNUnhandled exception in the code
Photo format errorInvalid imageIdCard/imageBest Format(Support?jpg?jpeg?png)
ERROR_NO_FACE_DETECTEDInvalid imageIdCard/imageBest has no face detected
FAILED_TO_READ_IMAGEFile decoding error.
FAILED_TO_WRITE_IMAGEFile encoding error.
FAILED_TO_READ_MODELModel deserializing error.
INVALID_CONFIGConfiguration file deserializing error.
NO_SUCH_OBJECT_IN_BUILDEngine or backend is not supported by the build.
INVALID_FUSE_MODEInvalid fuse mode_provided.
NULLPTRNullptr provided.
FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICTLiveness prediction error.
FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECTFace detection error.
MISSING_MANDATORY_FIELDMissing mandatory fields
🇳​​​​​🇪​​​​​🇼 EYES_CLOSEDValidate if the eyes on a face were not closed.
### Centralized OkayLive Sample Response {% code title="Missing imageBest " %} ``` { "status": "error", "message": "Data field is compulsory." } ``` {% endcode %} ### Centralized OkayDoc(passport) | Error Code | Description | | ------------------------------------------------------------------------ | ------------------------------------------------- | | Error in verifying passport. | Missing fullSizeImage/halfSizeImage/country field | | Empty verification result. Suspected error during verification document. | Missing halfSizeImage | | UNSUPPORTED\_COUNTRY | Missing/Invalid country | | Internal Server Error | Missing/Invalid country | ### Centralized OkayDoc(passport) Sample Response {% code title="Missing halfSizeImage" %} ``` { "status": "error", "messageCode": "api.error", "message": "Empty verification result. Suspected error during verification document." } ``` {% endcode %} {% code title="Missing/Invalid country" %} ``` { "status": "error", "messageCode": "api.error", "message": "UNSUPPORTED_COUNTRY" } ``` {% endcode %} {% code title="Missing/Invalid type" %} ``` { "timestamp": "2020-06-25T06:52:12.318+0000", "status": 500, "error": "Internal Server Error", "message": "No message available", "path": "/api/ekyc/okaydoc" } ``` {% endcode %} ### Centralized OkayDoc(non passport) | Error Code | Description | | ----------------------------------------------------------------------- | --------------------------- | | UNSUPPORTED\_COUNTRY | Invalid/Unsupported country | | Internal Server Error | Invalid/Unsupported country | | Empty verification result. Suspected error during verification document | Missing idImageBase64Image | | EMPTY\_DOCTYPE | Missing idImageBase64Image | | UNRECOGNIZED\_DOCTYPE | Invalid docType | | ERROR\_IN\_FIELD\_VERSION | Missing parameter "version" | ### Centralized OkayDoc(non passport) Sample Response {% code title="Invalid/Unsupported country" %} ``` { "status": "error", "messageCode": "api.error", "message": "UNSUPPORTED_COUNTRY" } ``` {% endcode %} {% code title="Invalid/Unsupported country" %} ``` { "timestamp": "2020-06-25T06:53:00.411+0000", "status": 500, "error": "Internal Server Error", "message": "No message available", "path": "/api/ekyc/okaydoc" } ``` {% endcode %} {% code title="Missing idImageBase64Image" %} ``` { "status": "error", "messageCode": "api.error", "message": "Empty verification result. Suspected error during verification document." } ``` {% endcode %} {% code title="Missing idImageBase64Image" %} ``` { "status": "error", "message": "EMPTY_DOCTYPE" } ``` {% endcode %} {% code title="Invalid docType" %} ``` { "status": "error", "message": "UNRECOGNIZED_DOCTYPE" } ``` {% endcode %} {% code title="Missing parameter "version"" %} ``` { "status": "error", "message": "ERROR_IN_FIELD_VERSION" } ``` {% endcode %} ### Get scorecard result | Error Code | Description | | ------------------------------------------------------------ | ----------------------- | | Document type (xxx) detected. No scorecard config file found | Config file not found | | Document type not found | No record found | | INVALID\_JOURNEY\_ID | Invalid/Empty journeyid | ### Get scorecard result Sample Response {% code title="Config file not found" %} ``` { "status": "error", "messageCode": null, "message": "Document type (xxx) detected. No scorecard config file found.", "scorecardResult": null } ``` {% endcode %} {% code title="No record found" %} ``` { "status": "error", "messageCode": null, "message": "Document type not found.", "scorecardResultList": null } ``` {% endcode %} {% code title="Invalid/Empty journeyid" %} ``` { "status": "error", "messageCode": null, "message": "INVALID_JOURNEY_ID", "scorecardResultList": null } ``` {% endcode %} ### Get Scorecard Config | Error Code | Description | | ------------------------------------- | --------------------- | | CONFIG\_FILE\_NOT\_EXIST | Config file not exist | | ERROR\_IN\_GETTING\_SCORECARD\_CONFIG | Config file not exist | | USERNAME\_NOT\_EXIST | Config file not exist | ### Get Scorecard Config Sample Response {% code title="Config file not exist" %} ``` { "status": "error", "messageCode": null, "message": "CONFIG_FILE_NOT_EXIST", "lastModifiedDate": null, "configList": null, "scorecardList": null } ``` {% endcode %} {% code title="Config file not exist" %} ``` { "status": "error", "messageCode": null, "message": "ERROR_IN_GETTING_SCORECARD_CONFIG", "lastModifiedDate": null, "configList": null, "scorecardList": null } ``` {% endcode %} {% code title="Invalid/Empty password, invalid/empty docType" %} ``` { "status": "error", "messageCode": null, "message": "USERNAME_NOT_EXIST", "lastModifiedDate": null, "configList": null, "scorecardList": null } ``` {% endcode %} {% hint style="info" %} The error lists above only include the EMAS eKYC Portal errors. {% endhint %} --- # 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-ekycportal.innov8tif.com/emas-ekyc-portal/error-list.md?ask= ``` 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.