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. |
| IpInBlacklist | Your IP is in uin IP blacklist. |
| IpNotInWhitelist | Your IP is not in uin IP whitelist. |
| 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. |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | Uin exceeds the frequency limit. |
| RequestLimitExceeded.IPLimitExceeded | The number of ip requests exceeds the frequency limit. |
| RequestLimitExceeded.UinLimitExceeded | The number of uin 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. |
| ResponseSizeLimitExceeded | The response size exceeds the upper limit. |
| 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.CardSideError | The CardSide type of the ID card is incorrect. |
| FailedOperation.DownLoadError | File download failed. |
| FailedOperation.EmptyImageError | The image is empty. |
| FailedOperation.EngineRecognizeTimeout | Recognition by the engine timed out. |
| FailedOperation.IdCardInfoIllegal | The ID card information (ID number, name, etc.) is invalid. |
| FailedOperation.IdCardTooSmall | The resolution of the image is too low or the proportion of the ID card in the image is too small. |
| FailedOperation.IllegalBankCardError | Invalid bank card information. |
| FailedOperation.ImageBlur | The image is blurry. |
| FailedOperation.ImageDecodeFailed | Image decoding failed. |
| FailedOperation.ImageNoIdCard | No ID card is detected in the image. |
| FailedOperation.ImageNoSpecifiedCard | The card in the image is not of the specified type. |
| FailedOperation.ImageNoText | No text is detected in the image. |
| FailedOperation.ImageSizeTooLarge | The image is too large. Please see the description of image size limit in the output parameters. |
| FailedOperation.LanguageNotSupport | The input language is not supported. |
| FailedOperation.MultiCardError | There are multiple cards in the photo. |
| FailedOperation.NoBankCardError | No bank card found. |
| FailedOperation.NoHKIDCard | Not a Hong Kong identity card. |
| FailedOperation.NoMASIDCard | Non-Malaysian ID cards. |
| FailedOperation.NoPassport | Not a passport. |
| FailedOperation.OcrFailed | OCR failed. |
| FailedOperation.UnKnowError | Unknown error. |
| FailedOperation.UnOpenError | The service is not activated. |
| InvalidParameter.ConfigFormatError | Config is not in valid JSON format. |
| InvalidParameter.EngineImageDecodeFailed | Image decoding failed. |
| InvalidParameterValue.InvalidParameterValueLimit | Incorrect parameter value. |
| LimitExceeded.TooLargeFileError | The file is too large. |
| ResourceUnavailable.InArrears | |
| ResourceUnavailable.ResourcePackageRunOut | |
| ResourcesSoldOut.ChargeStatusException | Exceptional billing status. |
Yes
No
Was this page helpful?