Skip to content

Error Codes ​

pdf-writer (structured errors: code / next_actions / retryable) ​

CodeMeaning / what to do
INVALID_ARGUMENTInvalid argument
DOC_NOT_FOUNDInput PDF not found
FONT_NOT_FOUNDBad font path
INVALID_PDFBroken PDF
ENCRYPTED_PDFEncrypted PDFs cannot be edited
UNSUPPORTED_PDF_FEATUREUnsupported feature such as XFA
FILE_TOO_LARGESize limit exceeded
SIGNED_PDFSignature guard → preserveSignatures / allowBreakingSignatures
TAGGED_PDFTag guard → allowBreakingTags
FONT_REQUIREDCJK output needs a font → fontPath / PDF_WRITER_FONT
MISSING_GLYPHMissing glyph → onMissingGlyph
INTERNAL_ERRORInternal error

pdf-verify (structured errors: code / message / suggestion) ​

A tool result with isError: true whose text is { "error": true, "code", "message", "suggestion" }. The codes are pdf-verify's own. ENCRYPTED_PDF in particular means something different here from pdf-writer's: pdf-writer refuses to edit the file, while pdf-verify refuses to hand the file to veraPDF.

CodeMeaning / what to do
MISSING_PATH / RELATIVE_PATH / FILE_NOT_FOUND / NOT_A_FILEBad file_path → pass an absolute path to an existing regular file
FILE_TOO_LARGESize limit exceeded
PARSE_FAILEDThe file's structure violates a clause of ISO 32000 and could not be read (from v0.20.0; earlier this came back as INTERNAL_ERROR). This is a finding about the document, not a server failure — do not file it under "checks not performed"
INVALID_BYTE_RANGEA signature's /ByteRange is not 4 numbers or points outside the file
INVALID_FLAVOURUnknown flavour for validate_conformance (PDF/A-4 has no pdfa-4b; PDF/UA takes pdfua-1 / pdfua-2)
ENCRYPTED_PDFvalidate_conformance did not hand an encrypted file to veraPDF. For PDF/A the file is out of the standard anyway (ISO 19005-1, 6.1.3) — record the veraPDF run as not performed (from v0.26.1; earlier INTERNAL_ERROR). For PDF/UA of a password-protected file → pass password
WRONG_PASSWORDThe supplied password is wrong, or the security handler is not the Standard one
VERAPDF_NOT_FOUND / VERAPDF_NOT_AVAILABLEveraPDF is not installed or cannot run → set PDF_VERIFY_VERAPDF, or use engine: "native" (a subset that cannot certify conformance)
VERAPDF_NO_RESULTveraPDF ran but returned no validation result (from v0.26.1). Neither a pass nor INTERNAL_ERROR
INTERNAL_ERRORInternal error

MIT Licensed