SDK Modes

The SDK can operate in one of three modes that control how it captures and processes data. The mode is set at initialization with the sdkMode parameter, and can be changed at runtime with setSdkMode().

Mode	Description
`standard`	Default capture and validation behavior.
`captureOnly`	Offline capture mode. For ID and Selfie scan, only captures images without validations.
`submitOnly`	Submit previously captured data without performing new capture steps.

Set the mode at initialization

await IncodeSdk.initialize({
  testMode: false,
  sdkMode: 'standard',
  apiConfig: {
    key: 'YOUR_API_KEY',
    url: 'YOUR_API_URL',
  },
});

If sdkMode is omitted, the SDK defaults to standard.

Change the mode after initialization

await IncodeSdk.setSdkMode('captureOnly');