Preflight Rules Reference

This page provides a summary of available preflight validation rules. For the complete reference, see the onprem documentation.

Available Rules

Rule Type	Description
colorspace	Validates color space of images. Use allowedColorSpaces parameter to specify allowed values (e.g., ["CMYK"]).
spotcolors	Validates spot colors. Use allowedSpotColors parameter to specify allowed spot color names.
resolution	Validates image resolution. Use target parameter to specify minimum DPI.
safetyboxes	Validates defined boxes (TrimBox, BleedBox, etc.).
nomargins	Validates that no important content is too close to trim edge.
insideBleedbox	Validates that all content is within the bleed box.
sameorientation	Validates that all pages have the same orientation.
forbiddenfonts	Validates that no forbidden fonts are used. Use forbiddenFonts parameter.
allowedfonts	Validates that only allowed fonts are used. Use allowedFonts parameter.
fonttypes	Validates font types. Use allowedFontTypes parameter.
minfontsize	Validates minimum font size. Use minSize parameter.
textascurves	Validates that text is converted to curves.
embeddedfonts	Validates that fonts are embedded in the PDF.

Common Parameters

Parameter	Type	Description
severity	string	"error" or "warning" - determines if the issue must be fixed
enableFix	boolean	If true, displays a Fix button for autofix
pages	number[] | string[]	Target pages (e.g., [1,3] or ["/2"] for every 2nd page)
params	object	Rule-specific parameters

Example

{
    "rules": [
        {
            "type": "colorspace",
            "severity": "error",
            "enableFix": true,
            "params": {
                "allowedColorSpaces": ["CMYK"]
            }
        },
        {
            "type": "resolution",
            "severity": "warning",
            "params": {
                "target": 300
            }
        }
    ]
}

For the complete rules reference with all parameters, see the Preflight rules documentation.