Watchlist for Business Module

Warning

This guide is specific to Web SDK 2.x. For Web SDK 1.x, you can find documentation here.

Do not attempt to upgrade or implement without support. Contact your Incode representative to check if you are a candidate for this upgrade.

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.

This module follows the form-based pattern.

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:

Status	Description
`idle`	Initial state.
`form`	Rendering the form (country + business name inputs).
`submitting`	Submitting the form to the backend.
`success`	Submission accepted.
`finished`	Terminal.

Form-state properties

Property	Type	Description
`country`	`string`	Selected ISO country code.
`businessName`	`string`	Current business name.
`isValid`	`boolean`	Current input validity.
`validationErrors`	`{ businessName?: string }` (optional)	Translation key for the required-name error.
`canSubmit`	`boolean`	Whether Continue is enabled.

These properties exist only in form. In 2.3.0, canSubmit is optimistic: Continue starts enabled and required-field errors appear after a failed submit. It does not prove completeness.

API methods

Method	Purpose	Callable when
`load()`	Enter the form. Call this before setting inputs.	`idle`
`setCountry(country)`	Set the ISO country code.	`form`
`setBusinessName(value)`	Set the business name.	`form`
`submit()`	Validate and submit the inputs.	`form`

import { createWatchlistForBusinessManager } from '@incodetech/core/watchlist-for-business';

const manager = createWatchlistForBusinessManager();
manager.load();
if (manager.getState().status === 'form') {
  manager.setCountry('US');
  manager.setBusinessName('Example Business');
  // Submit in response to the user's Continue action:
  manager.submit();
}

Subscribe before loading to render state changes. On teardown, unsubscribe and call stop(); create a new manager for a new verification.