SDK reference, Incode Web SDK 2 Reference / Web SDK 2 Individual Modules

Cross-Document Data Match 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 Cross-Document Data Match module runs a backend comparison of OCR data across multiple captured documents (e.g., ID + proof-of-address) and flags inconsistencies. Fire-and-forget — completes after a minimum display duration so the user sees a confirmation spinner.

Follows the backend-process pattern. See the patterns page for the shared lifecycle.

Tag

<incode-cross-document-data-match> is a standard Web Component. Importing the UI subpath registers the custom element; the module is bundled with @incodetech/web/flow (no separate UI subpath import).

import '@incodetech/web/cross-document-data-match';

Properties

Property Type Required Description
config CrossDocumentDataMatchConfig ❌ No options
onFinish () => void ❌ Called when comparison completes
onError (error: string) => void ❌ Called when an error occurs

Configuration

The module takes no configuration:

type CrossDocumentDataMatchConfig = Record<string, never>;

Comparison rules and inconsistency thresholds are configured server-side per tenant.

State machine

CrossDocumentDataMatchState is a discriminated union over status:

Status Description
idle Initial state.
processing Backend comparison in progress.
finished Terminal — comparison completed.

The module deliberately holds the processing state for a minimum display duration so users see a confirmation spinner regardless of how fast the backend responds.

See also

Was this page helpful?