Error List

General

Error Code	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

Error Code	Description
Internal Server Error	Missing base64ImageString
UNRECOGNIZED_IMAGE	Image is not recognized by the system

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

Centralized OkayFace

Error Code	Description
UNEXPECTED_ERROR	System fail to process the face verification
UNRECOGNIZED_IMAGE	Image is not recognized by the system
INTEG_ERROR	OkayFace integration error
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

Centralized OkayFace Sample Response

Unhandled exception

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

Missing imageIdCardBase64 & imageBestBase64

{
    "status": "error"
}

Invalid imageBest/imageBestBase64

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

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 OkayLive - Other errors returned in 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

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
}