Error Codes

Last updated: 2021-03-11 17:57:55

Feature Description

If there is an Error field in the response, it means that the API call failed. For example:

 {
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "The provided credentials could not be validated. Please check your signature is correct."
        },
        "RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
    }
}

Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List

Common Error Codes

Error Code Description
ActionOffline This API has been deprecated.
AuthFailure.InvalidAuthorization Authorization in the request header is invalid.
AuthFailure.InvalidSecretId Invalid key (not a TencentCloud API key type).
AuthFailure.MFAFailure MFA failed.
AuthFailure.SecretIdNotFound Key does not exist. Check if the key has been deleted or disabled in the console, and if not, check if the key is correctly entered. Note that whitespaces should not exist before or after the key.
AuthFailure.SignatureExpire Signature expired. Timestamp and server time cannot differ by more than five minutes. Please ensure your current local time matches the standard time.
AuthFailure.SignatureFailure Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation.
AuthFailure.TokenFailure Token error.
AuthFailure.UnauthorizedOperation The request is not authorized. For more information, see the CAM documentation.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError Internal error.
InvalidAction The API does not exist.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidRequest The multipart format of the request body is incorrect.
LimitExceeded Quota limit exceeded.
MissingParameter A parameter is missing.
NoSuchProduct The product does not exist.
NoSuchVersion The API version does not exist.
RequestLimitExceeded The number of requests exceeds the frequency limit.
RequestSizeLimitExceeded The request size exceeds the upper limit.
ResourceInUse Resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable.
ServiceUnavailable Service is unavailable now.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
UnsupportedProtocol HTTP(S) request protocol error; only GET and POST requests are supported.
UnsupportedRegion API does not support the requested region.

Service Error Codes

Error Code Description
FailedOperation.ActionCloseEye No motions of eye closing are detected.
FailedOperation.ActionFaceClose The face is too close to the screen.
FailedOperation.ActionFaceFar The face is too far from the screen.
FailedOperation.ActionFaceLeft The face is too far left from the screen.
FailedOperation.ActionFaceRight The face is too far right from the screen.
FailedOperation.ActionFirstAction The first motion is not detected.
FailedOperation.ActionLightDark The lighting is too dim.
FailedOperation.ActionLightStrong The lighting is too strong.
FailedOperation.ActionNodetectFace Failed to detect a full face.
FailedOperation.ActionOpenMouth No motions of mouth opening are detected.
FailedOperation.CompareFail Comparison failed.
FailedOperation.CompareLowSimilarity The comparison similarity did not reach the passing standard.
FailedOperation.CompareSystemError Error calling the comparison engine API.
FailedOperation.FileSaveError Failed to store the file. Please try again later.
FailedOperation.IdFormatError The ID number entered is incorrect.
FailedOperation.IdNameMisMatch The name and ID number do not match. Please check and try again.
FailedOperation.IdNoExistSystem The number is not in the library. Please go to the applicable household registrar for check.
FailedOperation.IdPhotoNoExist The photo is not in the library. Please go to the applicable household registrar for check.
FailedOperation.IdPhotoPoorQuality The ID photo resolution is too low. Please upload a new one.
FailedOperation.IdPhotoSystemNoanswer Failed to return a photo from the customer library or authentication center. Please try again later.
FailedOperation.LifePhotoDetectFaces Multiple faces are detected.
FailedOperation.LifePhotoDetectFake Real person comparison failed.
FailedOperation.LifePhotoDetectNoFaces Failed to detect a full face.
FailedOperation.LifePhotoPoorQuality The resolution of the image passed in is too low. Please upload a new one.
FailedOperation.LifePhotoSizeError The image passed in is too large or too small.
FailedOperation.LipFaceIncomplete The face is not fully exposed.
FailedOperation.LipMoveSmall The lip movement range is too small.
FailedOperation.LipNetFailed Failed to pull the video. Please try again.
FailedOperation.LipSizeError The video is empty or its size is inappropriate. The recording duration should be about 6 seconds.
FailedOperation.LipVideoInvalid The video format is incorrect.
FailedOperation.LipVideoQuaility The video definition is too low.
FailedOperation.LipVoiceDetect No sound is detected.
FailedOperation.LipVoiceLow The volume of the video is too low.
FailedOperation.LipVoiceRecognize Speech recognition failed.
FailedOperation.LivessBestFrameError Face detection failed. Unable to extract the photo for comparison.
FailedOperation.LivessDetectFail Liveness detection failed.
FailedOperation.LivessDetectFake Suspected spoofed recording.
FailedOperation.LivessSystemError Error calling the liveness engine API.
FailedOperation.LivessUnknownError Video-based real person detection failed.
FailedOperation.NameFormatError The name entered is incorrect.
FailedOperation.SilentDetectFail Real person detection failed.
FailedOperation.SilentEyeLiveFail Eye detection failed.
FailedOperation.SilentFaceDetectFail No face is detected in the video.
FailedOperation.SilentFaceQualityFail Low face quality.
FailedOperation.SilentFaceWithMaskFail A face mask is detected.
FailedOperation.SilentMouthLiveFail Mouth detection failed.
FailedOperation.SilentMultiFaceFail Multiple faces are detected in the video.
FailedOperation.SilentPictureLiveFail The video might be spoofed.
FailedOperation.SilentThreshold Real person detection did not reach the passing standard.
FailedOperation.SilentTooShort The video is too short. Please capture a video longer than 2 seconds.
FailedOperation.UnKnown Unknown internal error.
UnauthorizedOperation.Arrears The account is in arrears.
UnauthorizedOperation.NonAuthorize Identity verification has not been completed for the account.
UnauthorizedOperation.Nonactivated The service has not been activated.