Errors
Error Code Reference
Return Parameters
| Return Parameter | Data Type | Description |
|---|---|---|
| code | String | Error code |
| msg | String | Error description |
Return the Example
java
{
"code": "<code>",
"msg": "<describe>"
}Refer to
| Code | Describe |
|---|---|
| 400 | Bad credentials |
| 01001 | System internal error |
| 01002 | Failed to upload processed files to the server |
| 01003 | Failed to upload files |
| 01004 | Failed to download files |
| 01005 | The file cannot be empty |
| 01006 | Abnormal file parameters: Please set valid file parameters |
| 01201 | System memory problem |
| 01202 | Unknown error |
| 01203 | Can't find or open the file |
| 01204 | Unsupported security mechanism |
| 01206 | The CSV file does not exist |
| 01207 | Failed to call DocumentAI APIs |
| 01208 | Failed to write the recognized and returned data to the file |
| 02001 | File format error |
| 02002 | Unsupported file format for conversion |
| 02201 | The file is encrypted |
| 02203 | Abnormal PDF file |
| 02204 | Unsupported file format (Only PDF is supported) |
| 02206 | Invalid file content or pages don't exist |
| 02207 | Failed to open the file: Unsupported file format or encrypted file |
| 02208 | Failed to initialize ExcelXml |
| 02209 | Conversion timeout, please do not upload too large files |
| 02210 | File conversion failed |
| 02211 | Conversion Failed: Converted and generated a file with an abnormal file size |
| 03000 | Parameter validation error |
| 04001 | The fileKey does not exist |
| 04002 | The file size is zero. There is no content in your file |
| 04003 | Your file does not exist or cannot be opened |
| 04004 | Failed to Compress Compared Files |
| 04005 | Document Comparison can only work with two files |
| 05001 | Invalid task |
| 05002 | Abnormal task status |
| 05003 | Processing files in one task has reached the threshold (5 files) |
| 05004 | Task expired and unexecuted |
| 05005 | At least one file should be processed in one task |
| 06001 | You have run out of the files which could be processed |
| 07001 | Unsupported feature |
Status Code
The ComPDFKit API uses HTTP status codes to return the results of your request. We mainly use three scopes to inform you of the results of your request:
200 - The status code of the response is 200, indicating that the API call is successful.
401 - The API will send this status when the Token is not set or the Token you specified is invalid.
413 - When your request size exceeds the limit, the API will send this status.