Watchlist for Business Module

📘

This guide is specific to Web SDK 2.0. If you are still using 1.x, you can find documentation here. Contact your Incode Representative for upgrade information and check if you are a candidate for this upgrade.

Full rollout to all clients still TBD.


The Watchlist for Business module collects a country and business name from the user, then screens against Incode's business-watchlist endpoint. Differs from the personal Watchlist modules in that it has user input — it's a form-based flow followed by a backend submit.

Follows the form-based pattern. See the patterns page for the shared lifecycle.

Availability

This module is headless-only — there is no public <incode-watchlist-for-business> web component. Drive it with createWatchlistForBusinessManager from @incodetech/core/watchlist-for-business.

Configuration

The module takes no configuration:

type WatchlistForBusinessConfig = Record<string, never>;

Country list and threshold rules are configured server-side.

State machine

WatchlistForBusinessState is a discriminated union over status:

StatusDescription
idleInitial state.
formRendering the form (country + business name inputs).
submittingSubmitting the form to the backend.
successSubmission accepted.
finishedTerminal.

See also