Create & mount

Create the factory

const fc = Filecheck('pk_live_…', {
  agentId: 'agt_…',   // optional sub-tenant scope
  // iframeSrc: '…',  // staging/dev override only
});

agentId (sub-tenant scope). Pass an agentId (agt_…) to scope the Element to a specific sub-tenant under your account — useful when one account serves multiple stores or brands. Leave it out to use your account default. The e-commerce plugins expose it as an optional setting.TODO(filecheck): define what an agent/sub-tenant is, when to use one, and where to obtain an agentId in the dashboard.

Create an intake element

const intake = fc.elements.create('intake', {
  workflowId: 'wf_…',       // required unless resuming with jobId
  presentation: 'inline',   // 'inline' (default) | 'dialog'
});

Create options

string

The Workflow to run. Required unless jobId is provided.

string

Resume an existing job. When set, workflowId is ignored.

'inline' | 'dialog'

default:"inline"

Render inline in the page flow, or behind a trigger button as a dialog.

string

Locale for the widget UI, for example en-US.

object

Map file facts onto your product-page controls. See Connectors.

string

Resolve a connector server-side by id (cntr_…).

object

UI overrides: title, subtitle, theme, accent, layout, showHeader, submitLabel, autoSubmit, and more.

Methods

intake.mount('#fc-slot');        // or .mount(htmlElement)

intake.update({ workflowId: 'wf_…', ui: { theme: 'dark' } });

intake.focus();                  // open a dialog/drawer layout programmatically
intake.blur();

intake.respondToProof(true);     // approve a soft-proof gate
intake.setConnector({ /* … */ }); // replace the active connector
intake.applyNow();               // re-run the connector against the last facts

intake.unmount();

intake.on(...) returns an unsubscribe function. See Events.

The Element

Store plugins

Custom integrations

Official libraries

Server-side

Reference

Create the factory

Create an intake element

Create options

Methods

​Create the factory

​Create an intake element

​Create options

​Methods

Create the factory

Create an intake element

Create options

Methods