Error Codes
Error Response Format
PDF processing service error responses use the following JSON structure:
json
{
"code": 110001,
"message": "page range out of bounds: 0-99",
"traceId": "a1b2c3d4e5f6..."
}| Field | Type | Description |
|---|---|---|
code | Integer | 6-digit numeric error code, programmatic identifier |
message | String | Error description with field name or context |
traceId | String | Full-link trace ID |
Common Service Error Codes
These errors are handled by the service framework and apply to all ComPDF API endpoints.
01xxx — System Errors
| Code | HTTP | Description |
|---|---|---|
01001 | 500 | Internal system error |
01002 | 500 | Failed to upload processed file to storage |
01003 | 500 | File upload error |
01004 | 500 | Failed to download your uploaded file |
01005 | 400 | File cannot be empty |
01006 | 400 | Invalid parameters, please set valid file parameters |
01007 | 400 | Task ID cannot be empty |
02xxx — File Format Errors
| Code | HTTP | Description |
|---|---|---|
02001 | 400 | File format error |
02002 | 400 | Unsupported file format for processing |
02003 | 400 | Unsupported image format |
02201 | 400 | The file is encrypted |
02207 | 400 | Failed to open file: unsupported format or encrypted |
02209 | 413 | File too large, please upload a smaller file |
02210 | 500 | File processing failed |
02212 | 500 | File processing failed: abnormal output file size |
03000 — Parameter Validation Error
| Code | HTTP | Description |
|---|---|---|
03000 | 400 | Parameter validation failed, typically due to missing required fields or incorrect field formats |
04xxx — File & Business Errors
| Code | HTTP | Description |
|---|---|---|
04001 | 400 | File key does not exist |
04002 | 400 | File size is zero |
04003 | 400 | File does not exist or cannot be opened |
04007 | 400 | Only one file is allowed for this endpoint |
04008 | 400 | Merge PDF supports at most 5 files |
05xxx — Task Errors
| Code | HTTP | Description |
|---|---|---|
05001 | 404 | Task does not exist or is invalid |
05002 | 409 | Abnormal task status |
05003 | 400 | File count per task has reached the threshold |
05004 | 410 | Task expired and was not executed |
05005 | 400 | At least one file is required per task |
06001 — Insufficient Assets
| Code | HTTP | Description |
|---|---|---|
06001 | 402 | You have run out of processing quota, please purchase a plan |
Authentication & Authorization
| HTTP | Code | Description |
|---|---|---|
401 | 401 | Invalid or missing API Key; authentication service unavailable |
403 | 403 | Insufficient permissions |
PDF Functional Error Codes
These errors originate from the PDF processing service.
100xxx — General Request & File Errors
| Code | Error Code | HTTP | Description |
|---|---|---|---|
100001 | INVALID_ARGUMENT | 400 | Missing, wrong type, or invalid enumeration value |
100002 | INVALID_JSON | 400 | JSON parsing failed |
100003 | CONFLICTING_ARGUMENTS | 400 | Mutually exclusive parameters provided together |
100101 | INVALID_FILE_TYPE | 400 | File type does not meet endpoint requirements |
100102 | FILE_REQUIRED | 400 | Required file field is missing |
100103 | FILE_COUNT_MISMATCH | 400 | Multi-file count does not match parameter array count |
100104 | FILE_TOO_LARGE | 413 | File size exceeds server limit |
100106 | INVALID_OUTPUT_FILE_NAME | 400 | Invalid output file name |
110xxx — Page & Coordinate Errors
| Code | Error Code | HTTP | Description |
|---|---|---|---|
110001 | INVALID_PAGE_RANGE | 400 | Invalid page range or page number out of bounds |
110002 | INVALID_PAGE_INDEX | 400 | Negative page index or exceeds document page count |
110003 | INVALID_RECT | 400 | Invalid rectangle parameters |
110005 | PAGE_RANGE_EMPTY | 400 | No processable pages after parsing |
120xxx — Password & Certificate Errors
| Code | Error Code | HTTP | Description |
|---|---|---|---|
120001 | PASSWORD_REQUIRED | 400 | Document is encrypted but no password provided |
120002 | INVALID_PASSWORD | 400 | Incorrect PDF password |
120101 | CERTIFICATE_INVALID | 400 | Certificate file cannot be parsed or format unsupported |
120102 | CERTIFICATE_PASSWORD_REQUIRED | 400 | Certificate requires a password but none provided |
120103 | CERTIFICATE_PASSWORD_INVALID | 400 | Incorrect certificate password |
120201 | ICC_PROFILE_REQUIRED | 400 | ICC file required for standardization conversion |
130xxx — Business State Errors
| Code | Error Code | HTTP | Description |
|---|---|---|---|
130002 | UNSUPPORTED_ENUM_VALUE | 400 | Enumeration value is not within allowed range |
130101 | SIGNATURE_NOT_FOUND | 404 | Specified signature does not exist |
130102 | WATERMARK_NOT_FOUND | 404 | Specified watermark does not exist |
130103 | BACKGROUND_NOT_FOUND | 404 | No operable background in document |
130104 | HEADER_FOOTER_NOT_FOUND | 404 | No header/footer configuration in document |
130105 | BATES_NOT_FOUND | 404 | No Bates numbering in document |
130106 | REDACTION_NOT_FOUND | 404 | No applicable redaction marks found |
130107 | NO_CHANGES_DETECTED | 422 | Operation succeeded but no changes produced |
190xxx — Processing & System Errors
| Code | Error Code | HTTP | Description |
|---|---|---|---|
190001 | PROCESS_FAILED | 500 | Service processing failed (document open/save/operation error) |
190002 | TEMP_FILE_WRITE_FAILED | 500 | Temporary file write failed |
190003 | TEMP_FILE_READ_FAILED | 500 | Temporary file read failed |
190004 | RESULT_PACKAGE_FAILED | 500 | Multi-file result packaging failed |
190999 | INTERNAL_ERROR | 500 | Unclassified internal error |
Retry Recommendations
| Error Code Range | Retryable | Recommendation |
|---|---|---|
100xxx | No | Fix request parameters or file and resubmit |
110xxx | No | Fix page numbers or coordinates and resubmit |
120xxx | No | Fix password or certificate and resubmit |
130xxx | No | Resource not found or business state error, fix request |
190xxx (except 190999) | Recommended | Service processing issues, backoff and retry (max 3 times) |
190999 | Recommended | Internal error, backoff and retry |
06001 | No | Purchase a plan to continue |
01xxx, 02xxx, 04xxx | No | Fix the file or parameters and retry |