eKYC
- Announcements
- Purchase Guide
- Integration Guide
- Selfie Verification (Pure API)
- Selfie Verification (Mobile HTML5)
- Selfie Verification (App SDK)
- SDK API Description
- SDK Custom Capabilities
- eKYC (Mobile HTML5)
- eKYC (App SDK)
- SDK API Description
- API Documentation
- Making API Requests
- Selfie Verification (App SDK) APIs
- eKYC (Mobile HTML5) APIs
- eKYC (App SDK) APIs
- Selfie Verification (Pure API) APIs
- AI Face Shield (Pure API) APIs
- ID Verification (Pure API) APIs
Error Codes
Last updated: 2025-02-28 15:56:48
This document describes all error codes of the eKYC product and whether a request is billed ("N" for no and "Y" for yes) in the case of an error code.
Common Error Codes (for All Services)
Error Code | Description | Billed |
InvalidParameter | Invalid parameter | N |
InvalidParameterValue.BizTokenIllegal | Invalid BizToken | N |
InvalidParameterValue.BizTokenExpired | BizToken expired | N |
UnauthorizedOperation.Nonactivated | The service has not been activated. | N |
UnauthorizedOperation.Activating | The service is being activated | N |
UnauthorizedOperation.ActivateError | The service has not been activated | N |
UnauthorizedOperation.Arrears | The account has overdue payments | N |
OperationDenied | Operation denied | N |
UnauthorizedOperation.NonAuthorize | Identity verification has not been completed for the account. | N |
UnauthorizedOperation | Unauthorized operation | N |
FailedOperation.ImageSizeTooLarge | Image size too large | N |
InternalError | Internal error | N |
The following tables list the error codes of the eKYC subproducts:
Selfie Verification (Mobile HTML5) Error Codes
Error Code | Description | Billed |
0 | Success, Tap Next to continue. | Y |
1 | Invalid parameter | N |
2 | Incorrect parameter value | N |
3 | Bad request | N |
4 | Internal service error | N |
8 | Internal service error | N |
9 | Internal service error | N |
10 | Internal service error | N |
11 | Internal service error | N |
14 | Verification has been completed | N |
15 | Token expired | N |
16 | Retry limit has been reached | N |
202 | Failed to get video | N |
1001 | Failed to call the liveness engine | N |
1002 | Suspected spoofed recording. | N |
1003 | Real person detection failed | N |
1004 | Face detection failed | N |
1005 | Liveness detection failed | N |
1101 | No sound is detected | N |
1102 | The face is not fully exposed | N |
1103 | Speech recognition failed | N |
1104 | The video format is incorrect | N |
1105 | Failed to pull the video. Please try again | N |
1106 | The volume of the video is too low | N |
1107 | The video is empty or its size is inappropriate. The recording duration should be about 6 seconds | N |
1108 | The video definition is too low | N |
1109 | The lip movement range is too small | N |
1201 | The lighting is too dim | N |
1202 | The lighting is too strong | N |
1203 | The face is too close to the screen | N |
1204 | The face is too far right from the screen | N |
1205 | The face is too far from the screen | N |
1206 | The face is too far left from the screen | N |
1207 | No motions of eye closing are detected | N |
1208 | The first motion is not detected | N |
1209 | No motions of mouth opening are detected | N |
1210 | Failed to detect a full face | N |
1211 | Mouth opening detected during liveness detection | N |
1301 | Real person detection failed | N |
1302 | Real person detection did not reach the passing standard | N |
1303 | The video is too short. Please capture a video longer than 2 seconds | N |
1401 | face reflect liveness detect failed | N |
1402 | Liveness detection failed, you have not enabled downgrade mode | N |
2001 | Error calling the comparison engine | N |
2004 | The image passed in is too large or too small | N |
2010 | Multiple faces are detected | N |
2011 | Real person comparison failed | N |
2012 | Failed to detect a full face | N |
2013 | No faces are detected | N |
2014 | The resolution of the image passed in is too low. Please upload a new one | N |
2015 | Comparison failed | N |
2016 | The comparison similarity did not reach the passing standard | Y |
4001 | missing token | N |
4002 | token not found | N |
4003 | Incorrect token | N |
4004 | token has expired | N |
4005 | token completed | N |
4006 | operation is too frequent | N |
3001 | Verification Failed. | N |
3002 | OCR retry over limit | N |
3003 | liveness retry over limit | Y |
3004 | fail to get user authorization | N |
3005 | API is not compatible | N |
3006 | retry limit error，fail to enable the downgrade mode | N |
5001 | server internal error | N |
5002 | Incorrect parameter value | N |
6001 | ocr service error | N |
6002 | retry limit error | N |
6003 | card file is too large | N |
6004 | ocr process failed | N |
6005 | async ocr processing | N |
6006 | ocr detection of counterfeiting warnings | Y |
6007 | ocr maximum polling Limit | N |
7001 | authentication failed | N |
7002 | You‘ve been blocked，please contact Tencent Cloud | N |
Selfie Verification (Mobile HTML5) Capture Prompts
Prompt |
please blink |
please open your mouth |
nod please |
please shake your head |
Please keep your face within the detection frame |
No face detected |
Please make sure there is only one face in the detection frame |
Please move your face into the detection frame |
Please come closer |
Please stay away |
Please move to left |
Please move to right |
Please move up |
Please move down |
Please do not cover the left face |
Please do not cover your right face |
Current light: too dark |
Current light: too bright |
Please do not cover the left eye |
Please do not cover the right eye |
Please do not cover your nose |
Please do not cover your mouth |
Face detection timed out, and recognition failed |
invalid request |
Connection lost |
Connection lost |
read websocket message error |
invalid token |
invalid action sequence |
Token expired |
missing best frame |
engine init fail |
invoke engine failed |
engine network failed |
invalid engine response |
unknown error |
Verifying, please hold your posture. |
Please wait a moment for the result… |
Please don't open your mouth. |
Selfie Verification (App SDK) Error Codes
Error Code | Description | Billed |
0 | Succeeded | Y |
1001 | System error | N |
1004 | Selfie verification failed | N |
2004 | The image passed in is too large or too small | N |
2012 | Several faces were detected | N |
2013 | No face was detected, or the face detected was incomplete | N |
2014 | The image resolution is too low or the quality does not meet the requirements | N |
2015 | Face comparison failed | N |
2016 | The similarity did not reach the standard passing threshold | Y |
-999 | The verification process wasn't finished | N |
Selfie Verification (Pure API) Error Codes
Error Code | Description | Billed |
Success | Success | Y |
FailedOperation.CompareLowSimilarity | The comparison similarity did not reach the passing standard. | Y |
FailedOperation.ActionCloseEye | No motions of eye closing are detected. | N |
FailedOperation.ActionFaceClose | The face is too close to the screen. | N |
FailedOperation.ActionFaceFar | The face is too far from the screen. | N |
FailedOperation.ActionFaceLeft | The face is too far left from the screen. | N |
FailedOperation.ActionFaceRight | The face is too far right from the screen. | N |
FailedOperation.ActionFirstAction | No movement is detected. | N |
FailedOperation.ActionLightDark | The lighting is too dim. | N |
FailedOperation.ActionLightStrong | The lighting is too strong. | N |
FailedOperation.ActionNodetectFace | Failed to detect a full face. | N |
FailedOperation.ActionOpenMouth | No motions of mouth opening are detected. | N |
FailedOperation.CompareFail | Comparison failed. | N |
FailedOperation.CompareSystemError | Error calling the comparison engine API. | N |
FailedOperation.DownLoadError | File download failed. | N |
FailedOperation.DownLoadTimeoutError | File download timed out. | N |
FailedOperation.LifePhotoDetectFaces | Multiple faces are detected. | N |
FailedOperation.LifePhotoDetectFake | Real person comparison failed. | N |
FailedOperation.LifePhotoDetectNoFaces | Failed to detect a full face. | N |
FailedOperation.LifePhotoPoorQuality | The resolution of the image passed in is too low. Please upload a new one. | N |
FailedOperation.LifePhotoSizeError | The image passed in is too large or too small. | N |
FailedOperation.LipFaceIncomplete | The face is not fully exposed. | N |
FailedOperation.LipMoveSmall | The lip movement range is too small. | N |
FailedOperation.LipNetFailed | Failed to pull the video. Please try again. | N |
FailedOperation.LipSizeError | The video is empty or its size is inappropriate. The recording duration should be about 6 seconds. | N |
FailedOperation.LipVideoInvalid | The video format is incorrect. | N |
FailedOperation.LipVideoQuaility | The video definition is too low. | N |
FailedOperation.LipVoiceDetect | No sound is detected. | N |
FailedOperation.LipVoiceLow | The volume of the video is too low. | N |
FailedOperation.LipVoiceRecognize | Speech recognition failed. | N |
FailedOperation.LivessBestFrameError | Face detection failed. Unable to extract the photo for comparison. | N |
FailedOperation.LivessDetectFail | Liveness detection failed. | N |
FailedOperation.LivessDetectFake | Suspected spoofed recording. | N |
FailedOperation.LivessSystemError | Error calling the liveness engine API. | N |
FailedOperation.LivessUnknownError | Video-based real person detection failed. | N |
FailedOperation.SilentDetectFail | Real person detection failed. | N |
FailedOperation.SilentEyeLiveFail | Eye detection failed. | N |
FailedOperation.SilentFaceDetectFail | No face is detected in the video. | N |
FailedOperation.SilentFaceQualityFail | Low face quality. | N |
FailedOperation.SilentFaceWithMaskFail | A face mask is detected. | N |
FailedOperation.SilentMouthLiveFail | Mouth detection failed. | N |
FailedOperation.SilentMultiFaceFail | Multiple faces are detected in the video. | N |
FailedOperation.SilentPictureLiveFail | The video might be spoofed. | N |
FailedOperation.SilentThreshold | Real person detection did not reach the passing standard. | N |
FailedOperation.SilentTooShort | The video is too short. Please capture a video longer than 2 seconds. | N |
FailedOperation.UnKnown | Unknown internal error. | N |
InvalidParameter | Invalid parameter. | N |
InvalidParameterValue | Incorrect parameter value. | N |
UnauthorizedOperation | Unauthorized operation. | N |
UnauthorizedOperation.Arrears | The account has overdue payments | N |
UnauthorizedOperation.NonAuthorize | Identity verification has not been completed for the account. | N |
UnauthorizedOperation.Nonactivated | The service has not been activated. | N |
UnsupportedOperation | Unsupported operation. | N |
Identity Verification (App SDK) Error Codes
Error Code | Description | Billed |
0 | Success | Y |
1001 | Failed to call the liveness engine | Y |
1004 | Face detection failed | Y |
2004 | The image passed in is too large or too small | Y |
2012 | Failed to detect a full face | Y |
2013 | No faces are detected | Y |
2014 | The resolution of the image passed in is too low. Please upload a new one | Y |
2015 | Comparison failed | Y |
2016 | The comparison similarity did not reach the passing standard | Y |
iOS Error Codes
Error Code | Description |
0 | Successful |
210 | Parameter initialization exception |
211 | Bundle configuration exception |
212 | YouTu configuration exception |
213 | Call the API for initialization first |
214 | SDK authorization failure |
215 | Manually canceled by user |
216 | Local face detection failure of SDK |
217 | Failed to enable the camera |
218 | Do not switch the application during liveness detection and face comparison |
219 | Camera permission exception |
220 | Failed to clip the video |
221 | Incorrect light data format |
222 | Action detect time out |
223 | Package over limitaion size |
227 | Reflective mode please do not use back camera |
272 | Network error |
300 | Prepare process timeout |
301 | Time-consuming detection timeout |
302 | Do not enable video recording during the process |
303 | Do not enable screen shots during the process |
Android Error Codes
Error Code | Description |
210 | Network request exception. |
211 | Check failed during local SDK initialization. The common exceptions are license file nonexistence or license expiration. |
212 | The user actively cancels the liveness detection and face comparison process. |
213 | An internal exception of the SDK occurred, causing the liveness detection and face comparison process to be stopped. |
214 | Applications are switched during liveness detection and face comparison, causing the process to be stopped. |
215 | An exception occurred while getting the camera. |
216 | The liveness detection and face comparison method is directly called before the "init()" method is called. |
217 | Local face detection failed. |
218 | The permissions required by the local SDK are insufficient. |
219 | If reflectSequence of startAuthByLightData is null, you stopped the liveness detection and face comparison process. |
220 | Failed to verify the light sequence parameter. |
221 | An exception occurred while directly calling the method for setting light sequence parameters without getting the device configuration. |
222 | Local motion detection timed out. |
223 | Preparation timed out (between camera launch and the first detection of face). |
224 | Failed to apply for the camera permission inside the SDK. |
227 | Reflective mode please do not use back camera |
228 | Illegal TOKEN |
SDK Error Codes
SDK Service Error Codes
Error Code | Description | Billed |
1004 | Face detection failed | Y |
1001 | Failed to call the liveness engine | Y |
2016 | The comparison similarity did not reach the passing standard | Y |
2015 | Comparison failed | N |
2004 | The image passed in is too large or too small | N |
2014 | The resolution of the image passed in is too low. Please upload a new one | N |
2013 | No faces are detected | N |
SDK OCR Error Codes
Error Code | Description | Billed |
ResultCode | File download error | Y |
FailedOperation.DownLoadError | Service failed | Y |
FailedOperation.UnOpenError | File is too large | Y |
LimitExceeded.TooLargeFileError | Charge status exception | Y |
ResourcesSoldOut.ChargeStatusException | invalid parameter | Y |
InvalidParameterValue.InvalidParameterValueLimit | Unkonwn error | Y |
FailedOperation.UnKnowError | Please check the picture format | Y |
FailedOperation.ImageDecodeFailed | OCR Failed | Y |
FailedOperation.OcrFailed | not Hongkong ID Card | Y |
FailedOperation.NoHKIDCard | in arrear | Y |
ResourceUnavailable.InArrears | Service failed | Y |
FailedOperation.WarningServiceFailed | Please check the picture format | Y |
InvalidParameter.EngineImageDecodeFailed | not MLID Card | Y |
FailedOperation.NoMASIDCard | Resource package run out | Y |
ResourceUnavailable.ResourcePackageRunOut | Not passport | Y |
FailedOperation.NoPassport | no image | Y |
FailedOperation.EmptyImageError | Blur image | Y |
FailedOperation.ImageBlur | Unspecified type of picture | Y |
FailedOperation.ImageNoSpecifiedCard | Please check the picture format | Y |
InvalidParameter.ConfigFormatError | No image detected | Y |
FailedOperation.ImageNoIdCard | image is too large | Y |
FailedOperation.ImageSizeTooLarge | Please check the picture format | Y |
FailedOperation.MultiCardError | Please check the picture format | Y |
FailedOperation.IdCardInfoIllegal | Please check the picture format | Y |
FailedOperation.CardSideError | image is too small | Y |
FailedOperation.InvalidInfoFormat | Invalid "%s" （%s），please take the photo again | Y |
SDK Process Error Code
Error Code | Description |
1001 | missing token |
1002 | token not found |
1003 | Incorrect token |
1004 | token has expired |
1005 | token completed |
1007 | params invalid |
1008 | The times of usage is limited |
1009 | risk detection reject |
1010 | frequency limited |
1011 | This card type does not support editing |
3002 | Ocr Failed. |
3003 | async OCR processing |
3004 | async OCR apply ID verification token failed |
3005 | OCR Warnings. |
4001 | Check mode is not match. |
5001 | server internal error |
6001 | Liveness best frame detection failed |
6002 | Detect Liveness best frame to hit |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No