PDF error codes
Every public API error code emitted by PDF, with its HTTP status, its type and a page per code.
Error codes emitted by PDF. Each code links to its own page with the cause and the action to take.
| Code | Type | HTTP | Description |
|---|---|---|---|
invalid_pdf_artifact_fingerprint | invalid_request_error | 422 | The PDF artifact fingerprint is invalid. |
invalid_pdf_template_configuration | invalid_request_error | 422 | A value of the template configuration breaks a rule of the template model; param gives the path of the offending field. |
pdf_artifact_not_found | not_found_error | 404 | The PDF artifact does not exist for this company, or it was a preview that has expired. |
pdf_artifact_not_ready | service_unavailable_error | 503 | The PDF is still being prepared. |
pdf_commercial_identity_not_found | not_found_error | 404 | The commercial identity does not exist in this company. |
pdf_commercial_identity_required | invalid_request_error | 422 | The brand mode of the template (logo or image) needs a commercial identity and the company has no default one to fall back on. |
pdf_commercial_identity_unavailable | invalid_request_error | 422 | The commercial identity exists but is archived or incompatible with this operation. |
pdf_engine_profile_unavailable | api_error | 500 | The PDF rendering profile is unavailable. |
pdf_engine_unreachable | service_unavailable_error | 503 | The PDF engine did not answer (down, restarting or in the middle of a deployment). It is transient: the same request works when the engine is back, and nothing was created or changed. |
pdf_image_resource_unavailable | api_error | 500 | The PDF image resource is unavailable. |
pdf_legal_source_changed | conflict_error | 409 | The current legal source no longer matches this retained presentation. |
pdf_library_association_coverage_incomplete | api_error | 500 | The platform could not verify every default, series or recurrence that uses the template, so the impact of the operation cannot be guaranteed. The failure is on our side. |
pdf_library_impact_conflict | conflict_error | 409 | The defaults, series or recurrences affected by the operation changed after you reviewed its impact. |
pdf_main_template_required | conflict_error | 409 | The company already works with the PDF template library, where the design (pdf_template) and accent colour (accent_color) of the personalization are applied to its main template, and it has no main template to apply them to. |
pdf_original_corrupt | api_error | 500 | The integrity of the original PDF cannot be verified. |
pdf_original_layout_unavailable | api_error | 500 | The layout the original PDF was generated with is no longer available in this version of Factuarea. |
pdf_original_unavailable | api_error | 500 | The original PDF is unavailable. |
pdf_payload_resource_unavailable | api_error | 500 | The resources required to prepare the PDF are unavailable. |
pdf_presentation_conflict | conflict_error | 409 | The presentation changed after you read it, so the expected_version you sent is stale. |
pdf_presentation_context_changed | conflict_error | 409 | The data the preview was built from (document, company or template context) changed after the preview was produced. |
pdf_presentation_etag_mismatch | conflict_error | 412 | The ETag sent in If-Match no longer matches the stored presentation, which was modified after you read it. |
pdf_presentation_invalid | invalid_request_error | 422 | The presentation does not satisfy a field or content rule. |
pdf_presentation_not_found | not_found_error | 404 | The document presentation does not exist for this company or does not belong to the document you queried. |
pdf_presentation_not_ready | invalid_request_error | 422 | The revisioned presentation is not available for this company yet: its activation is pending. |
pdf_presentation_precondition_required | invalid_request_error | 428 | The change to the presentation did not state which version it is based on. |
pdf_signature_personal_data_forgotten | not_found_error | 410 | Personal signature data for this presentation has been erased. |
pdf_template_access_denied | authorization_error | 403 | The credential or user does not have permission to perform this operation on the PDF template library. |
pdf_template_archived | invalid_request_error | 422 | The PDF template is archived, and an archived template cannot be assigned or edited. |
pdf_template_asset_conflict | conflict_error | 409 | A template asset with that identifier already exists, so the upload would overwrite it. |
pdf_template_asset_not_found | not_found_error | 404 | The template asset (logo, image or font) does not exist in this company or was removed. |
pdf_template_default_replacement_required | invalid_request_error | 422 | Archiving the template would leave defaults or associations without a template, and no replacement was given for them. |
pdf_template_not_found | not_found_error | 404 | The PDF template does not exist in this company. |
pdf_template_precondition_failed | conflict_error | 412 | The ETag sent in If-Match no longer matches the stored template, which was modified after you read it. |
pdf_template_precondition_required | invalid_request_error | 428 | Changing the template requires stating the version it is based on, and none was sent. |
pdf_template_version_conflict | conflict_error | 409 | The template was modified after you read it, so the expected_version you sent is stale. |
preparation_required | conflict_error | 409 | Prepare the PDF for this presentation before requesting it. |
Related
Error codes by category
Find an error by the category that emits it.
Full reference table
All codes, HTTP statuses, types and descriptions in one reference.
Error model
Interpret the error envelope and handle errors by code.