# Filecheck

## Docs

- [Authentication](https://docs.filecheck.io/docs/api-reference/authentication.md): Publishable keys run in the browser, secret keys run on your server. How Filecheck keys and scopes work.
- [Get a connector](https://docs.filecheck.io/docs/api-reference/connectors/get-a-connector.md)
- [List connectors](https://docs.filecheck.io/docs/api-reference/connectors/list-connectors.md): Lists connectors (domain-scoped entries merged with the built-in store catalog). Each item is tagged with a `source` of `domain` or `store`.
- [API overview](https://docs.filecheck.io/docs/api-reference/introduction.md): Base URL, authentication, and conventions for the Filecheck REST API.
- [Delete a job](https://docs.filecheck.io/docs/api-reference/jobs/delete-a-job.md)
- [Fix a file](https://docs.filecheck.io/docs/api-reference/jobs/fix-a-file.md): Sugar wrapper for preflight + autofix, plus an optional re-preflight when `repreflight: true`. Async (201) by default.
- [Generate previews](https://docs.filecheck.io/docs/api-reference/jobs/generate-previews.md): Sugar wrapper. Renders preview images for a file. Async (201) by default; `sync: true` waits for the result.
- [Get a job](https://docs.filecheck.io/docs/api-reference/jobs/get-a-job.md): Returns the full Job with child Tasks and steps. Use `?expand=runs` for a flattened per-file summary with proof and download URLs.
- [List jobs](https://docs.filecheck.io/docs/api-reference/jobs/list-jobs.md)
- [Optimize a file](https://docs.filecheck.io/docs/api-reference/jobs/optimize-a-file.md): Sugar wrapper. Runs an optimize-only job. Async (201) by default; `sync: true` waits for the result.
- [Preflight a file](https://docs.filecheck.io/docs/api-reference/jobs/preflight-a-file.md): Sugar wrapper. Runs a preflight-only job. Async (201) by default; `sync: true` waits for the result.
- [Submit a job](https://docs.filecheck.io/docs/api-reference/jobs/submit-a-job.md): Canonical job submission. Each entry in `sources[]` is one source file plus the ordered `steps[]` to run on it. Async (201) by default; set `sync: true` to wait up to ~27s.
- [Validate a file](https://docs.filecheck.io/docs/api-reference/jobs/validate-a-file.md): Sugar wrapper. Validates a file against one or more PDF/A or PDF/UA conformance levels. Sync by default; set `async: true` to return 201 immediately.
- [Get a optimizepreset](https://docs.filecheck.io/docs/api-reference/optimizepresets/get-a-optimizepreset.md)
- [List optimize-presets](https://docs.filecheck.io/docs/api-reference/optimizepresets/list-optimize-presets.md): Lists optimize-presets (domain-scoped entries merged with the built-in store catalog). Each item is tagged with a `source` of `domain` or `store`.
- [Capture an order](https://docs.filecheck.io/docs/api-reference/orders/capture-an-order.md): Records a commerce order and links its line items (and their Filecheck `jobId`s) to the caller. Currently shaped for WooCommerce (`source: "wp"`).
- [Get a profile](https://docs.filecheck.io/docs/api-reference/profiles/get-a-profile.md)
- [List profiles](https://docs.filecheck.io/docs/api-reference/profiles/list-profiles.md): Lists profiles (domain-scoped entries merged with the built-in store catalog). Each item is tagged with a `source` of `domain` or `store`.
- [Get a rule](https://docs.filecheck.io/docs/api-reference/rules/get-a-rule.md)
- [List rules](https://docs.filecheck.io/docs/api-reference/rules/list-rules.md): Lists rules (domain-scoped entries merged with the built-in store catalog). Each item is tagged with a `source` of `domain` or `store`.
- [Create an upload](https://docs.filecheck.io/docs/api-reference/uploads/create-an-upload.md): Mints presigned S3 POST credentials so a client can upload a large file directly (up to 500 MB). Returns a `fileRef` usable as a job source. Credentials expire in 300 seconds.
- [Get a workflow](https://docs.filecheck.io/docs/api-reference/workflows/get-a-workflow.md)
- [List workflows](https://docs.filecheck.io/docs/api-reference/workflows/list-workflows.md): Lists workflows (domain-scoped entries merged with the built-in store catalog). Each item is tagged with a `source` of `domain` or `store`.
- [Building blocks](https://docs.filecheck.io/docs/concepts/building-blocks.md): The objects that power Filecheck: Rules, Preflight Profiles, Workflows, Jobs, and Optimization Presets; and how they fit together.
- [Jobs](https://docs.filecheck.io/docs/concepts/jobs.md): A Job is a single execution run of one or more files through Filecheck. Gate checkout on the job's canProceed flag.
- [Remediation](https://docs.filecheck.io/docs/concepts/remediation.md): Filecheck prefers fixing files over rejecting them. What gets auto-corrected on ingestion.
- [Soft-proofing](https://docs.filecheck.io/docs/concepts/soft-proofing.md): Let customers approve automated changes before they proceed. How the proof gate works.
- [Workflows](https://docs.filecheck.io/docs/concepts/workflows.md): A Workflow is the automated fulfillment stream a file travels through — combining intake, soft-proofing, trigger events, and downstream processing steps.
- [Configure a Connector](https://docs.filecheck.io/docs/configuration/connectors.md): Map facts Filecheck derives from a file onto your product page's own controls — no custom code.
- [Jobs & output](https://docs.filecheck.io/docs/configuration/jobs.md): Every file run produces a Job. Where to find results, and how to run a one-off preflight, validation, or optimization.
- [Admin guide](https://docs.filecheck.io/docs/configuration/overview.md): How the Filecheck admin is organized, and how to configure each part — profiles, rules, workflows, jobs, and presets.
- [Create a Preflight Profile](https://docs.filecheck.io/docs/configuration/preflight.md): Build a reusable set of checks that decide whether an uploaded file is print-ready — and what to do when it isn't.
- [Colors](https://docs.filecheck.io/docs/configuration/preflight/color.md): Color checks in a PDF preflight profile — color mode, ink coverage, spot colors, ICC/output intent, rich black, and overprint.
- [Fonts, Text & Strokes](https://docs.filecheck.io/docs/configuration/preflight/fonts-text.md): Font and text checks in a PDF preflight profile — embedding, subsetting, minimum sizes, stroke widths, outlining, and safe zones.
- [Images](https://docs.filecheck.io/docs/configuration/preflight/images.md): Image checks in a PDF preflight profile — effective resolution, compression, color space, and bit depth of images placed inside the PDF.
- [Page Checks](https://docs.filecheck.io/docs/configuration/preflight/page-checks.md): Geometry checks in a PDF preflight profile — page count, size, orientation, bleed, trim, safety margins, rotation, and layout.
- [Page Rules](https://docs.filecheck.io/docs/configuration/preflight/page-rules.md): Per-page overrides in a PDF preflight profile — apply different checks to specific pages, like covers vs. interior.
- [PDF Structure](https://docs.filecheck.io/docs/configuration/preflight/pdf-structure.md): Structural and content-integrity checks in a PDF preflight profile — transparency, layers, interactivity, security, versions, and print standards.
- [Raster Checks](https://docs.filecheck.io/docs/configuration/preflight/raster.md): The full check set for a Raster preflight profile — for standalone image uploads like JPEG, PNG, and TIFF.
- [Create an Optimization Preset](https://docs.filecheck.io/docs/configuration/presets.md): A reusable transform that forces a PDF or Raster file into a target shape — independent of preflight.
- [Create a Rule](https://docs.filecheck.io/docs/configuration/upload-rules.md): A Rule is the intake gate — what customers may upload, how many files, and how each file is checked while they wait.
- [Build a Workflow](https://docs.filecheck.io/docs/configuration/workflows.md): Assemble the pipeline a file travels through — intake while the customer waits, then processing once a trigger fires.
- [Connectors](https://docs.filecheck.io/docs/element/connectors.md): Sync file facts (page count, dimensions) onto your product-page controls without custom code.
- [Create & mount](https://docs.filecheck.io/docs/element/create-and-mount.md): The Filecheck factory, the intake element, its create options, and its methods.
- [Events](https://docs.filecheck.io/docs/element/events.md): Subscribe to the Element lifecycle: ready, status, facts, ui, error, proof, and destroy.
- [Installation](https://docs.filecheck.io/docs/element/installation.md): Load the Filecheck Element from the CDN, handle async loading, and size the mount point.
- [The Element Overview](https://docs.filecheck.io/docs/element/overview.md): What the Filecheck Element is, how it works, and how it handles real-time file preflight and gating.
- [Presentation & Filecheck.mount](https://docs.filecheck.io/docs/element/presentation.md): Choose inline or dialog presentation, or use Filecheck.mount for zero-JS plugin integration.
- [Introduction](https://docs.filecheck.io/docs/index.md): Filecheck is a real-time preflight, validation, and policy layer for file uploads. Automatically inspect, auto-correct, and proof PDFs, images, and documents before they ever reach your storage.
- [Headless & custom platforms](https://docs.filecheck.io/docs/integrations/headless.md): Use the Element on any stack, then verify the job server-side with the REST API.
- [OpenCart & PrestaShop](https://docs.filecheck.io/docs/integrations/opencart-prestashop.md): The shared front-end snippet for OpenCart, PrestaShop, and any other CMS.
- [Shopify](https://docs.filecheck.io/docs/integrations/shopify.md): Add the Filecheck Element to a Shopify product page with a theme app extension and cart attributes.
- [WooCommerce](https://docs.filecheck.io/docs/integrations/woocommerce.md): Gate add-to-cart on file validation in WooCommerce, and attach the checked file to the order.
- [Quickstart](https://docs.filecheck.io/docs/quickstart.md): How to sign up, connect your e-commerce store, and start gating and auto-fixing uploads in under 10 minutes.
- [Changelog](https://docs.filecheck.io/docs/reference/changelog.md): Notable changes to the Filecheck Element and API.
- [Errors & common mistakes](https://docs.filecheck.io/docs/reference/errors.md): The error event, plus the integration mistakes that trip people up most often.
- [Facts](https://docs.filecheck.io/docs/reference/facts.md): File measurements emitted alongside every status event. Dimensions are in millimetres.
- [Status payload](https://docs.filecheck.io/docs/reference/status-payload.md): The shape of the status event. Gate your submit button on canProceed.
- [Verify jobs](https://docs.filecheck.io/docs/server/verify-jobs.md): Use your secret key to fetch a job server-side and download the fixed output file.
- [Webhooks](https://docs.filecheck.io/docs/server/webhooks.md): Receive job results as they happen instead of polling the API.
- [Custom API / SDK integration](https://docs.filecheck.io/docs/tutorials/api-integration.md): Add Filecheck to any stack by embedding the Element or calling the REST API.
- [OpenCart installation](https://docs.filecheck.io/docs/tutorials/opencart-installation.md): Install the Filecheck module and require validated uploads on product pages.
- [Tutorials](https://docs.filecheck.io/docs/tutorials/overview.md): Install Filecheck on your store and learn how to use the admin.
- [PrestaShop installation](https://docs.filecheck.io/docs/tutorials/prestashop-installation.md): Install the Filecheck module and require validated uploads on product pages.
- [Shopify installation](https://docs.filecheck.io/docs/tutorials/shopify-installation.md): The Filecheck Shopify app is coming soon.
- [WordPress / WooCommerce installation](https://docs.filecheck.io/docs/tutorials/wordpress-installation.md): Install the Filecheck plugin, add your keys, and gate add-to-cart on file validation.

## OpenAPI Specs

- [openapi](https://docs.filecheck.io/docs/openapi.json)

## Optional

- [Demos](https://filecheck.io/demos)
- [Support](mailto:support@filecheck.io)