# Filecheck ## Docs - [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`. - [Authentication](https://docs.filecheck.io/docs/authentication.md): Publishable keys run in the browser, secret keys run on your server. How Filecheck keys and scopes work. - [Jobs](https://docs.filecheck.io/docs/concepts/jobs.md): A job is one run of a file (or set of files) through a Workflow. Gate on its 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 defines which files are accepted, what validation runs, and what happens on failure. - [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. - [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 preflight and policy layer for file uploads. Inspect, validate, and auto-fix PDFs, images, and documents before they 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): Embed the Filecheck Element, gate a submit button, and verify the result. From zero to a working integration. - [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. ## OpenAPI Specs - [openapi](https://docs.filecheck.io/docs/openapi.json) ## Optional - [Demos](https://filecheck.io/demos) - [Support](mailto:support@filecheck.io)