Search docsIDmission.com ↗
Mobile SDKs18 pages
Mobile SDKs / IDCaptureOptions

IDCaptureOptions

← Browse native SDK reference

Imported 2026-10-21View original source ↗How updates workRead Markdown
On this page · 4 sections
IDentity-SDK/com.idmission.sdk2.client.model/IDCaptureOptions

IDCaptureOptions

public final class IDCaptureOptions implements Parcelable

Provides options to change threshold or default threshold in ID Capture Screens.

Constructors

public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled, Long idInstructionAnimationDuration, Boolean isBarcodeRecoveryEnabled, Integer missingBarcodeTimeInterval, Integer barcodeRecoveryMoveCloserTimeInterval, Integer barcodeRecoveryCaptureTimeInterval)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled, Long idInstructionAnimationDuration, Boolean isBarcodeRecoveryEnabled, Integer missingBarcodeTimeInterval, Integer barcodeRecoveryMoveCloserTimeInterval)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled, Long idInstructionAnimationDuration, Boolean isBarcodeRecoveryEnabled, Integer missingBarcodeTimeInterval)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled, Long idInstructionAnimationDuration, Boolean isBarcodeRecoveryEnabled)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled, Long idInstructionAnimationDuration)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled, Boolean isIdInstructionAnimationEnabled)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit, Boolean isIDCapturePreviewEnabled)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence, Integer consecutiveFakeIdCaptureLimit)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec, Boolean separateIdCardCaptureSequence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode, Integer wrongDocumentTypeWarningDelayInSec)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs, WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence, Long allowOverrideWrongDocumentTypeAfterMs)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence, Float documentBackComponentConfidence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence, Float minBarcodeConfidence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold, Float minMrzConfidence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold, Float glareDetectionThreshold)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold, Float fingerDetectionThreshold)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance, Float focusThreshold)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance, Float upperWidthThresholdTolerance)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence, Float lowerWidthThresholdTolerance)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence, Float backDocumentConfidence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold, Float frontDocumentConfidence)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio)
public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode)
public IDCaptureOptions IDCaptureOptions()

Properties

private Long allowOverrideWrongDocumentTypeAfterMs

Option to set timer to allow override wrong document type. Default is 8000.

private Float backDocumentConfidence

Option to set Back ID Classification threshold. Minimum ID Back classification confidence percentage, represented as a value between 0 .0and 1.0. Default is 0.7.

private Float backRealnessThreshold

Option to set back ID realness threshold. Minimum ID back capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.3

private Integer barcodeRecoveryCaptureTimeInterval

Barcode Recovery capture window in seconds, started once the bbox-growth requirement is met (user confirmed to have moved closer). The best readable crop within this window is captured. Type: Int
nullable: false
example: 5

private Integer barcodeRecoveryMoveCloserTimeInterval

Barcode Recovery "move closer" window in seconds. This timer runs from the moment Barcode Recovery starts, independently of whether a barcode is detected, so the user can never be stuck indefinitely. If the barcode bounding box does not grow enough (user moving closer) before this elapses, recovery completes with the best image gathered so far. Type: Int
nullable: false
example: 10

private Integer consecutiveFakeIdCaptureLimit

Option to set a maximum ID capture retry limit for repeated fake ID attempts. Default is 3.

private Float documentBackComponentConfidence

Option to set document back component confidence detection. document back component Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.70.

private Float documentFrameWidthRatio

Option to set document frame width Ratio. Default ratio is 1.428f, which sets the target to capture document.

private Float fingerDetectionThreshold

Option to set finger detection threshold. finger detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.30.

private Float focusThreshold

Option to set focus threshold. focus threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.98.

private Float frontDocumentConfidence

Option to set front ID Classification threshold. Minimum ID front classification confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7

private Float frontRealnessThreshold

Option to set front ID realness threshold. Minimum ID front capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.5

private Float glareDetectionThreshold

Option to set glare detection threshold. glare detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.20.

private IDCaptureOrientation idCaptureOrientationMode

Option to enable vertical ID capture orientation.

private Long idInstructionAnimationDuration

Option to set animation duration in Instruction screen for ID.

private Boolean isBarcodeRecoveryEnabled

Options to enable Barcode Recovery after accepted front/back ID captures when local barcode parsing fails. Type: Boolean
nullable: false

private Boolean isIDCapturePreviewEnabled

Options to enable ID Preview Screen. Type: Boolean
nullable: false

private Boolean isIdInstructionAnimationEnabled

Option to enable animation in Instruction screen for ID.

private Float lowerWidthThresholdTolerance

Option to set lower width threshold. Lower ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.2. A lower width threshold tolerance of 0.2 (20%) means that a scanned ID must fall within (100 - 20) = 80% of the capture overlay rectangle width.

private Float minBarcodeConfidence

Option to set min Barcode Confidence detection. Barcode Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

private Float minMrzConfidence

Option to set min Mrz Confidence detection. Mrz Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

private Integer missingBarcodeTimeInterval

Time in seconds to try capturing the barcode during ID back capture before proceeding without a decoded barcode string (may trigger Barcode Recovery flow). Type: Int
nullable: false
example: 5

private Boolean separateIdCardCaptureSequence

Option to enable separate ID card capture sequence preview. Default is false.

private Float upperWidthThresholdTolerance

Option to set upper width threshold. Upper ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.05. An upper width threshold tolerance of 0.05 (5%) means that a scanned ID must fall within (100 + 5) = 105% of the capture overlay rectangle width.

private WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode

Option to set wrong document type handling mode. Default is WrongDocumentTypeHandlingMode.MANUAL_CAPTURE.

private Integer wrongDocumentTypeWarningDelayInSec

Option to set wrong document type warning delay in seconds. Default is 5.

Functions

public final Long getAllowOverrideWrongDocumentTypeAfterMs()

Option to set timer to allow override wrong document type. Default is 8000.

public final Float getBackDocumentConfidence()

Option to set Back ID Classification threshold. Minimum ID Back classification confidence percentage, represented as a value between 0 .0and 1.0. Default is 0.7.

public final Float getBackRealnessThreshold()

Option to set back ID realness threshold. Minimum ID back capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.3

public final Integer getBarcodeRecoveryCaptureTimeInterval()

Barcode Recovery capture window in seconds, started once the bbox-growth requirement is met (user confirmed to have moved closer). The best readable crop within this window is captured. Type: Int
nullable: false
example: 5

public final Integer getBarcodeRecoveryMoveCloserTimeInterval()

Barcode Recovery "move closer" window in seconds. This timer runs from the moment Barcode Recovery starts, independently of whether a barcode is detected, so the user can never be stuck indefinitely. If the barcode bounding box does not grow enough (user moving closer) before this elapses, recovery completes with the best image gathered so far. Type: Int
nullable: false
example: 10

public final Integer getConsecutiveFakeIdCaptureLimit()

Option to set a maximum ID capture retry limit for repeated fake ID attempts. Default is 3.

public final Float getDocumentBackComponentConfidence()

Option to set document back component confidence detection. document back component Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.70.

public final Float getDocumentFrameWidthRatio()

Option to set document frame width Ratio. Default ratio is 1.428f, which sets the target to capture document.

public final Float getFingerDetectionThreshold()

Option to set finger detection threshold. finger detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.30.

public final Float getFocusThreshold()

Option to set focus threshold. focus threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.98.

public final Float getFrontDocumentConfidence()

Option to set front ID Classification threshold. Minimum ID front classification confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7

public final Float getFrontRealnessThreshold()

Option to set front ID realness threshold. Minimum ID front capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.5

public final Float getGlareDetectionThreshold()

Option to set glare detection threshold. glare detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.20.

public final IDCaptureOrientation getIdCaptureOrientationMode()

Option to enable vertical ID capture orientation.

public final Long getIdInstructionAnimationDuration()

Option to set animation duration in Instruction screen for ID.

public final Float getLowerWidthThresholdTolerance()

Option to set lower width threshold. Lower ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.2. A lower width threshold tolerance of 0.2 (20%) means that a scanned ID must fall within (100 - 20) = 80% of the capture overlay rectangle width.

public final Float getMinBarcodeConfidence()

Option to set min Barcode Confidence detection. Barcode Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

public final Float getMinMrzConfidence()

Option to set min Mrz Confidence detection. Mrz Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

public final Integer getMissingBarcodeTimeInterval()

Time in seconds to try capturing the barcode during ID back capture before proceeding without a decoded barcode string (may trigger Barcode Recovery flow). Type: Int
nullable: false
example: 5

public final Boolean getSeparateIdCardCaptureSequence()

Option to enable separate ID card capture sequence preview. Default is false.

public final Float getUpperWidthThresholdTolerance()

Option to set upper width threshold. Upper ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.05. An upper width threshold tolerance of 0.05 (5%) means that a scanned ID must fall within (100 + 5) = 105% of the capture overlay rectangle width.

public final WrongDocumentTypeHandlingMode getWrongDocumentTypeHandlingMode()

Option to set wrong document type handling mode. Default is WrongDocumentTypeHandlingMode.MANUAL_CAPTURE.

public final Integer getWrongDocumentTypeWarningDelayInSec()

Option to set wrong document type warning delay in seconds. Default is 5.

public final Boolean isBarcodeRecoveryEnabled()

Options to enable Barcode Recovery after accepted front/back ID captures when local barcode parsing fails. Type: Boolean
nullable: false

public final Boolean isIDCapturePreviewEnabled()

Options to enable ID Preview Screen. Type: Boolean
nullable: false

public final Boolean isIdInstructionAnimationEnabled()

Option to enable animation in Instruction screen for ID.

public final Unit setAllowOverrideWrongDocumentTypeAfterMs(Long allowOverrideWrongDocumentTypeAfterMs)

Option to set timer to allow override wrong document type. Default is 8000.

public final Unit setBackDocumentConfidence(Float backDocumentConfidence)

Option to set Back ID Classification threshold. Minimum ID Back classification confidence percentage, represented as a value between 0 .0and 1.0. Default is 0.7.

public final Unit setBackRealnessThreshold(Float backRealnessThreshold)

Option to set back ID realness threshold. Minimum ID back capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.3

public final Unit setBarcodeRecoveryCaptureTimeInterval(Integer barcodeRecoveryCaptureTimeInterval)

Barcode Recovery capture window in seconds, started once the bbox-growth requirement is met (user confirmed to have moved closer). The best readable crop within this window is captured. Type: Int
nullable: false
example: 5

public final Unit setBarcodeRecoveryEnabled(Boolean isBarcodeRecoveryEnabled)

Options to enable Barcode Recovery after accepted front/back ID captures when local barcode parsing fails. Type: Boolean
nullable: false

public final Unit setBarcodeRecoveryMoveCloserTimeInterval(Integer barcodeRecoveryMoveCloserTimeInterval)

Barcode Recovery "move closer" window in seconds. This timer runs from the moment Barcode Recovery starts, independently of whether a barcode is detected, so the user can never be stuck indefinitely. If the barcode bounding box does not grow enough (user moving closer) before this elapses, recovery completes with the best image gathered so far. Type: Int
nullable: false
example: 10

public final Unit setConsecutiveFakeIdCaptureLimit(Integer consecutiveFakeIdCaptureLimit)

Option to set a maximum ID capture retry limit for repeated fake ID attempts. Default is 3.

public final Unit setDocumentBackComponentConfidence(Float documentBackComponentConfidence)

Option to set document back component confidence detection. document back component Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.70.

public final Unit setDocumentFrameWidthRatio(Float documentFrameWidthRatio)

Option to set document frame width Ratio. Default ratio is 1.428f, which sets the target to capture document.

public final Unit setFingerDetectionThreshold(Float fingerDetectionThreshold)

Option to set finger detection threshold. finger detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.30.

public final Unit setFocusThreshold(Float focusThreshold)

Option to set focus threshold. focus threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.98.

public final Unit setFrontDocumentConfidence(Float frontDocumentConfidence)

Option to set front ID Classification threshold. Minimum ID front classification confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7

public final Unit setFrontRealnessThreshold(Float frontRealnessThreshold)

Option to set front ID realness threshold. Minimum ID front capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.5

public final Unit setGlareDetectionThreshold(Float glareDetectionThreshold)

Option to set glare detection threshold. glare detection threshold tolerance percentage, represented as a value between 0.0 and 1.0 Default is 0.20.

public final Unit setIdCaptureOrientationMode(IDCaptureOrientation idCaptureOrientationMode)

Option to enable vertical ID capture orientation.

public final Unit setIDCapturePreviewEnabled(Boolean isIDCapturePreviewEnabled)

Options to enable ID Preview Screen. Type: Boolean
nullable: false

public final Unit setIdInstructionAnimationDuration(Long idInstructionAnimationDuration)

Option to set animation duration in Instruction screen for ID.

public final Unit setIdInstructionAnimationEnabled(Boolean isIdInstructionAnimationEnabled)

Option to enable animation in Instruction screen for ID.

public final Unit setLowerWidthThresholdTolerance(Float lowerWidthThresholdTolerance)

Option to set lower width threshold. Lower ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.2. A lower width threshold tolerance of 0.2 (20%) means that a scanned ID must fall within (100 - 20) = 80% of the capture overlay rectangle width.

public final Unit setMinBarcodeConfidence(Float minBarcodeConfidence)

Option to set min Barcode Confidence detection. Barcode Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

public final Unit setMinMrzConfidence(Float minMrzConfidence)

Option to set min Mrz Confidence detection. Mrz Confidence detection, represented as a value between 0.0 and 1.0 Default is 0.50.

public final Unit setMissingBarcodeTimeInterval(Integer missingBarcodeTimeInterval)

Time in seconds to try capturing the barcode during ID back capture before proceeding without a decoded barcode string (may trigger Barcode Recovery flow). Type: Int
nullable: false
example: 5

public final Unit setSeparateIdCardCaptureSequence(Boolean separateIdCardCaptureSequence)

Option to enable separate ID card capture sequence preview. Default is false.

public final Unit setUpperWidthThresholdTolerance(Float upperWidthThresholdTolerance)

Option to set upper width threshold. Upper ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.05. An upper width threshold tolerance of 0.05 (5%) means that a scanned ID must fall within (100 + 5) = 105% of the capture overlay rectangle width.

public final Unit setWrongDocumentTypeHandlingMode(WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode)

Option to set wrong document type handling mode. Default is WrongDocumentTypeHandlingMode.MANUAL_CAPTURE.

public final Unit setWrongDocumentTypeWarningDelayInSec(Integer wrongDocumentTypeWarningDelayInSec)

Option to set wrong document type warning delay in seconds. Default is 5.

public abstract Unit writeToParcel(Parcel p0, Integer p1)
Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.