ISmartCaptureConfiguration

Configuration for the Smart Capture component.

Signature:

export interface ISmartCaptureConfiguration

Properties

Property	Type	Description
asmScriptUrl	string	Where the asm process script should be downloaded from.
exclusionDistance	number	The distance around the edge as a percentage of the image dimensions which will cause an image to be rejected. Increase this to require the identity document to be more centralised.
processingThreshold	number	How stringent are the validation checks on the images captured by the Smart Capture process.
recaptureAttempts	number	How many attempts should be made to capture a valid image before stopping.
recaptureDelay	number	How long to wait (in ms) before capturing another image if the previous one failed validation checks.
timeout	number	How long should the worker wait for the WASM to finish loading before aborting and falling back to camera input. This is necessary as it’s not possible to work out if the WASM has failed at this time, so it has to be assumed that if it hasn’t loaded in the given time, we shouldn’t wait any longer and move on as it’s likely failed.
workerScriptUrl	string	Where the worker process script should be downloaded from.

ISmartCaptureConfiguration.asmScriptUrl property

Where the asm process script should be downloaded from.

Signature:

asmScriptUrl?: string;

ISmartCaptureConfiguration.exclusionDistance property

The distance around the edge as a percentage of the image dimensions which will cause an image to be rejected. Increase this to require the identity document to be more centralised.

Signature:

exclusionDistance?: number;

ISmartCaptureConfiguration.processingThreshold property

How stringent are the validation checks on the images captured by the Smart Capture process.

Signature:

processingThreshold?: number;

ISmartCaptureConfiguration.recaptureAttempts property

How many attempts should be made to capture a valid image before stopping.

Signature:

recaptureAttempts?: number;

ISmartCaptureConfiguration.recaptureDelay property

How long to wait (in ms) before capturing another image if the previous one failed validation checks.

Signature:

recaptureDelay?: number;

ISmartCaptureConfiguration.timeout property

How long should the worker wait for the WASM to finish loading before aborting and falling back to camera input. This is necessary as it’s not possible to work out if the WASM has failed at this time, so it has to be assumed that if it hasn’t loaded in the given time, we shouldn’t wait any longer and move on as it’s likely failed.

Signature:

timeout?: number;

ISmartCaptureConfiguration.workerScriptUrl property

Where the worker process script should be downloaded from.

Signature:

workerScriptUrl?: string;