Error List

This page contains the error lists for all of the API components

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

Invalid JourneyID/ Empty JourneyID/ Data purged

{
    "status": "error",
    "messageCode": null,
    "message": "INVALID_JOURNEY_ID",
    "scorecardResult": null
}

Account expired

{
    "status": "error",
    "message": "ERROR_IDV_EXPIRED"
}

Missing username & password

{
    "status": "error",
    "message": "MISSING_PARAM_CRENDENTIAL"
}

Invalid username

{
    "status": "error",
    "message": "USERNAME_NOT_EXIST"
}

Invalid password

{
    "status": "error",
    "message": "INCORRECT_PASSWORD"
}

Hit Max Journey

{
    "status": "error",
    "message": "MAX_JOURNEY_EXCEEDED"
}

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

Missing base64ImageString

{
    "timestamp": "2020-12-28T09:41:52.223+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "No message available",
    "path": "/api/ekyc/okayid"
}

Image not recognized by the system

{
    "status": "error",
    "message": "UNRECOGNIZED_IMAGE"
}

Blacklisted ID No is detected

{
    "status": "error",
    "message": "BLACK_LIST_ID_NO"
}

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

Missing imageIdCardBase64 & imageBestBase64

{
    "status": "error"
}

Invalid imageBest/imageBestBase64

{
    "status": "error",
    "message": "FACE_IS_OCCLUDED"
}

Face not found in imageBest/imageBestBase64

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

imageBest or imageIdCard's file size > 3mb

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

Centralized OkayFace Plus

Message	Description
UNEXPECTED_ERROR	Timeout connecting to OkayFace Timeout connecting to server Connecting to an invalid server API
INVALID_API_KEY	Empty API Key Invalid API Key
API_KEY_EXPIRED	Expired API Key
MAX_API_CALL_EXCEEDED	API Key exceeded limit
MISSING_ARGUMENT	Empty "imageBest" data Empty "imageIdCard" data Empty "mobileSdkOutput" data
UNEXPECTED_ERROR	Invalid "imageBest" data i.e. a non-image type file was uploaded 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

Timeout connecting to OkayFace Timeout connecting to server Connecting to an invalid server API

{
    "error": "UNEXPECTED_ERROR"
}

Empty API Key Invalid API Key

{
    "error": "INVALID_API_KEY"
}

Expired API Key

{
    "error": "API_KEY_EXPIRED"
}

API Key exceeded limit

{
    "error": "MAX_API_CALL_EXCEEDED"
}

Empty "imageBest" data Empty "imageIdCard" data Empty "mobileSdkOutput" data

{
    "error": "MISSING_ARGUMENT"
}

Invalid "imageBest" data Invalid "imageIdCard" data

{
    "error": "UNEXPECTED_ERROR"
}

Invalid file uploaded for SDK Output file

{
    "error": "INVALID_MOBILE_SDK_OUTPUT"
}

Face is not found in either "imageBest" or "imageIdCard"

{
    "error": "FACE_NOT_FOUND"
}

Face is occluded in either "imageBest" or "imageIdCard"

{
    "error": "FACE_IS_OCCLUDED"
}

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

Multiple Faces Detected

{
    "status": "error",
    "message": "Too many faces detected"
}

Missing imageIdCardBase64 & imageBestBase64

{
    "status": "error"
}

Centralized OkayFace(/api/ekyc/okayface/v1-1 with livenessDetection set True) and OkayLive

Error	Meaning
FACE_TOO_CLOSE	A distance between face and camera is too small for preprocessing issues
FACE_CLOSE_TO_BORDER	Face is too close to one or more borders. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_CROPPED	Face is cropped. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_IS_OCCLUDED	There is occlusion on the face or it is difficult to see face, which degrades the quality of liveness
FACE_NOT_FOUND	Face detector can't find face on image
TOO_MANY_FACES	Face detector found more than one face on image
FACE_TOO_SMALL	Facial area is not big enough for analysis. Either interpupillary distance(80px) or face size(224 px) is below the configured value.
FACE_ANGLE_TOO_LARGE	Facial out-of-plane rotation angle is extremely large
FAILED_TO_PREDICT_LANDMARKS	Landmarks prediction error
UNKNOWN	Unhandled exception in the code
Photo format error	Invalid imageIdCard/imageBest Format(Support?jpg?jpeg?png)
ERROR_NO_FACE_DETECTED	Invalid imageIdCard/imageBest has no face detected
FAILED_TO_READ_IMAGE	File decoding error.
FAILED_TO_WRITE_IMAGE	File encoding error.
FAILED_TO_READ_MODEL	Model deserializing error.
INVALID_CONFIG	Configuration file deserializing error.
NO_SUCH_OBJECT_IN_BUILD	Engine or backend is not supported by the build.
INVALID_FUSE_MODE	Invalid fuse mode_provided.
NULLPTR	Nullptr provided.
FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICT	Liveness prediction error.
FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECT	Face detection error.
MISSING_MANDATORY_FIELD	Missing mandatory fields
🇳​​​​​🇪​​​​​🇼 EYES_CLOSED	Validate if the eyes on a face were not closed.

Centralized OkayLive Sample Response

Missing imageBest

{
    "status": "error",
    "message": "Data field is compulsory."
}

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

Missing halfSizeImage

{
    "status": "error",
    "messageCode": "api.error",
    "message": "Empty verification result. Suspected error during verification document."
}

Missing/Invalid country

{
    "status": "error",
    "messageCode": "api.error",
    "message": "UNSUPPORTED_COUNTRY"
}

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"
}

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

Invalid/Unsupported country

{
    "status": "error",
    "messageCode": "api.error",
    "message": "UNSUPPORTED_COUNTRY"
}

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"
}

Missing idImageBase64Image

{
    "status": "error",
    "messageCode": "api.error",
    "message": "Empty verification result. Suspected error during verification document."
}

Missing idImageBase64Image

{
    "status": "error",
    "message": "EMPTY_DOCTYPE"
}

Invalid docType

{
    "status": "error",
    "message": "UNRECOGNIZED_DOCTYPE"
}

Missing parameter "version"

{
    "status": "error",
    "message": "ERROR_IN_FIELD_VERSION"
}

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

Config file not found

{
    "status": "error",
    "messageCode": null,
    "message": "Document type (xxx) detected. No scorecard config file found.",
    "scorecardResult": null
}

No record found

{
    "status": "error",
    "messageCode": null,
    "message": "Document type not found.",
    "scorecardResultList": null
}

Invalid/Empty journeyid

{
    "status": "error",
    "messageCode": null,
    "message": "INVALID_JOURNEY_ID",
    "scorecardResultList": null
}

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

Config file not exist

{
    "status": "error",
    "messageCode": null,
    "message": "CONFIG_FILE_NOT_EXIST",
    "lastModifiedDate": null,
    "configList": null,
    "scorecardList": null
}

Config file not exist

{
    "status": "error",
    "messageCode": null,
    "message": "ERROR_IN_GETTING_SCORECARD_CONFIG",
    "lastModifiedDate": null,
    "configList": null,
    "scorecardList": null
}

Invalid/Empty password, invalid/empty docType

{
    "status": "error",
    "messageCode": null,
    "message": "USERNAME_NOT_EXIST",
    "lastModifiedDate": null,
    "configList": null,
    "scorecardList": null
}

The error lists above only include the EMAS eKYC Portal errors.