Global Watchlist

The Global Watchlist module screens the user's identity against sources of sanctions, Politically Exposed Persons (PEP) databases, and adverse media, returning any matches found across the configured sources. Watchlist sources and matching behavior are controlled by your Incode Flow or Workflow configuration. Screening matches and decisions are evaluated server-side. Retrieve the detailed screening outcome from Dashboard or your scoring response.

For an overview of this module and how it works, see Watchlist.

How you use this module depends on your integration pattern. In Patterns 1 and 2, you add the module to a FlowConfig in code as shown on this page. In Pattern 3, you define your modules and configuration in Dashboard as a Flow or Workflow and reference it by ID with startFlow() or startWorkflow() as shown on Run Flows Configured in Dashboard.

Add Global Watchlist

Add the module with addGlobalWatchlist().

flowConfigBuilder.addGlobalWatchlist()

flowConfigBuilder.addGlobalWatchlist();

Example

The example below adds Global Watchlist as the only step in the flow and listens for the result through onGlobalWatchlistProcessed().

val flowConfig = FlowConfig.Builder()
    .addGlobalWatchlist()
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onGlobalWatchlistProcessed(globalWatchlistResult: GlobalWatchlistResult) {
        // Global watchlist step processed. Inspect the result.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)

FlowConfig flowConfig = new FlowConfig.Builder()
    .addGlobalWatchlist()
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onGlobalWatchlistProcessed(@NonNull GlobalWatchlistResult globalWatchlistResult) {
        // Global watchlist step processed. Inspect the result.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);

Configuration Options

Global Watchlist has no configurable options. It is added with a no-argument builder method. You can restrict the module to specific watchlist categories and specify matching criteria through your Incode Flow or Workflow configuration.

Result

Global Watchlist delivers a GlobalWatchlistResult to the onGlobalWatchlistProcessed(GlobalWatchlistResult) callback on the OnboardingListener. Key fields include:

• Fields inherited from BaseResult:
  • resultCode: The ResultCode for this result.
  • error: When resultCode is ERROR, the Throwable that caused it; otherwise, null.
  • deviceStats: The DeviceStats snapshot of the device state when the result was produced.
  • motionStatus: Device motion assessment during capture. One of the following:
    • UNCLEAR: Motion could not be determined; the default.
    • PASS: Device motion was within acceptable limits.
    • FAIL: Excessive device motion was detected.

Errors surface through OnboardingListener.onError(Throwable). This module does not deliver a module-specific exception subtype.

For all fields, see GlobalWatchlistResult in API Reference.