A Job (job_…) represents a single transactional run of a file or set of files through a validation, preflight, or optimization pipeline.
Jobs are generated automatically when customer uploads flow through a storefront Workflow, but they can also be initiated manually by administrators for instant preflight or optimization (saving you from running a workflow “ritual”).
As a job progresses, it emits interactive, real-time status events.
Job statuses
Filecheck tracks the lifecycle of every file through standard statuses:
| Status | Meaning |
|---|
idle | No files uploaded yet (initial state). |
incomplete | Files have been added, but fewer than the Workflow’s Upload Rule requires. |
uploading | Files are actively transferring to our secure sandbox. |
processing | Filecheck is running preflight, validation, and automated remediation. |
ready | The files successfully passed all checks. |
partial | Minor warnings occurred, but are acceptable according to the Upload Rule’s onFail policy. |
rejected | One or more critical checks failed, blocking the file from proceeding. |
Gating with canProceed
To protect your checkout pipeline, Filecheck exposes a simple canProceed boolean alongside the job status.
canProceed is true only when the job is in a ready or partial status.- When
canProceed is false, your e-commerce plugin or custom submit button remains disabled.
Important Integration Guideline: Never attempt to re-derive the canProceed flag by reading individual status values or raw file structures. Filecheck automatically evaluates the assigned Upload Rule’s onFail policy and encapsulates it in canProceed. Always gate directly on this flag.
Persisting and retrieving job output
When canProceed is true, the browser receives a finalized jobId.
- At Checkout: The
jobId is passed and stored as meta-data on the customer’s order.
- Post-Purchase Fulfillment: The validated, fixed, or optimized production files can be retrieved in two ways:
- E-commerce Dashboard: Attached directly to the WooCommerce, Shopify, OpenCart, or PrestaShop order page for immediate download.
- Filecheck Portal: Searched and downloaded under the Jobs tab at admin.filecheck.io/jobs.
- REST API: Downloaded programmatically via
GET /jobs/{id} using your secret key. See Verify jobs.
