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)

@JvmOverloads()

public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold, Float backRealnessThreshold)

@JvmOverloads()

public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio, Float frontRealnessThreshold)

@JvmOverloads()

public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode, Float documentFrameWidthRatio)

@JvmOverloads()

public IDCaptureOptions IDCaptureOptions(IDCaptureOrientation idCaptureOrientationMode)

@JvmOverloads()

public IDCaptureOptions IDCaptureOptions()

Properties

allowOverrideWrongDocumentTypeAfterMs

private Long allowOverrideWrongDocumentTypeAfterMs

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

backDocumentConfidence

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.

backRealnessThreshold

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

barcodeRecoveryCaptureTimeInterval

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

barcodeRecoveryMoveCloserTimeInterval

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

consecutiveFakeIdCaptureLimit

private Integer consecutiveFakeIdCaptureLimit

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

documentBackComponentConfidence

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.

documentFrameWidthRatio

private Float documentFrameWidthRatio

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

fingerDetectionThreshold

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.

focusThreshold

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.

frontDocumentConfidence

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

frontRealnessThreshold

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

glareDetectionThreshold

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.

idCaptureOrientationMode

private IDCaptureOrientation idCaptureOrientationMode

Option to enable vertical ID capture orientation.

idInstructionAnimationDuration

private Long idInstructionAnimationDuration

Option to set animation duration in Instruction screen for ID.

isBarcodeRecoveryEnabled

private Boolean isBarcodeRecoveryEnabled

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

isIDCapturePreviewEnabled

private Boolean isIDCapturePreviewEnabled

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

isIdInstructionAnimationEnabled

private Boolean isIdInstructionAnimationEnabled

Option to enable animation in Instruction screen for ID.

lowerWidthThresholdTolerance

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.

minBarcodeConfidence

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.

minMrzConfidence

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.

missingBarcodeTimeInterval

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

separateIdCardCaptureSequence

private Boolean separateIdCardCaptureSequence

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

upperWidthThresholdTolerance

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.

wrongDocumentTypeHandlingMode

private WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode

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

wrongDocumentTypeWarningDelayInSec

private Integer wrongDocumentTypeWarningDelayInSec

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

Functions

describeContents

public abstract Integer describeContents()

getAllowOverrideWrongDocumentTypeAfterMs

public final Long getAllowOverrideWrongDocumentTypeAfterMs()

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

getBackDocumentConfidence

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.

getBackRealnessThreshold

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

getBarcodeRecoveryCaptureTimeInterval

public final Integer getBarcodeRecoveryCaptureTimeInterval()

getBarcodeRecoveryMoveCloserTimeInterval

public final Integer getBarcodeRecoveryMoveCloserTimeInterval()

getConsecutiveFakeIdCaptureLimit

public final Integer getConsecutiveFakeIdCaptureLimit()

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

getDocumentBackComponentConfidence

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.

getDocumentFrameWidthRatio

public final Float getDocumentFrameWidthRatio()

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

getFingerDetectionThreshold

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.

getFocusThreshold

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.

getFrontDocumentConfidence

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

getFrontRealnessThreshold

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

getGlareDetectionThreshold

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.

getIdCaptureOrientationMode

public final IDCaptureOrientation getIdCaptureOrientationMode()

Option to enable vertical ID capture orientation.

getIdInstructionAnimationDuration

public final Long getIdInstructionAnimationDuration()

Option to set animation duration in Instruction screen for ID.

getLowerWidthThresholdTolerance

public final Float getLowerWidthThresholdTolerance()

getMinBarcodeConfidence

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.

getMinMrzConfidence

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.

getMissingBarcodeTimeInterval

public final Integer getMissingBarcodeTimeInterval()

getSeparateIdCardCaptureSequence

public final Boolean getSeparateIdCardCaptureSequence()

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

getUpperWidthThresholdTolerance

public final Float getUpperWidthThresholdTolerance()

getWrongDocumentTypeHandlingMode

public final WrongDocumentTypeHandlingMode getWrongDocumentTypeHandlingMode()

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

getWrongDocumentTypeWarningDelayInSec

public final Integer getWrongDocumentTypeWarningDelayInSec()

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

isBarcodeRecoveryEnabled

public final Boolean isBarcodeRecoveryEnabled()

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

isIDCapturePreviewEnabled

public final Boolean isIDCapturePreviewEnabled()

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

isIdInstructionAnimationEnabled

public final Boolean isIdInstructionAnimationEnabled()

Option to enable animation in Instruction screen for ID.

setAllowOverrideWrongDocumentTypeAfterMs

public final Unit setAllowOverrideWrongDocumentTypeAfterMs(Long allowOverrideWrongDocumentTypeAfterMs)

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

setBackDocumentConfidence

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.

setBackRealnessThreshold

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

setBarcodeRecoveryCaptureTimeInterval

public final Unit setBarcodeRecoveryCaptureTimeInterval(Integer barcodeRecoveryCaptureTimeInterval)

setBarcodeRecoveryEnabled

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

setBarcodeRecoveryMoveCloserTimeInterval

public final Unit setBarcodeRecoveryMoveCloserTimeInterval(Integer barcodeRecoveryMoveCloserTimeInterval)

setConsecutiveFakeIdCaptureLimit

public final Unit setConsecutiveFakeIdCaptureLimit(Integer consecutiveFakeIdCaptureLimit)

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

setDocumentBackComponentConfidence

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.

setDocumentFrameWidthRatio

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.

setFingerDetectionThreshold

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.

setFocusThreshold

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.

setFrontDocumentConfidence

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

setFrontRealnessThreshold

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

setGlareDetectionThreshold

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.

setIdCaptureOrientationMode

public final Unit setIdCaptureOrientationMode(IDCaptureOrientation idCaptureOrientationMode)

Option to enable vertical ID capture orientation.

setIDCapturePreviewEnabled

public final Unit setIDCapturePreviewEnabled(Boolean isIDCapturePreviewEnabled)

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

setIdInstructionAnimationDuration

public final Unit setIdInstructionAnimationDuration(Long idInstructionAnimationDuration)

Option to set animation duration in Instruction screen for ID.

setIdInstructionAnimationEnabled

public final Unit setIdInstructionAnimationEnabled(Boolean isIdInstructionAnimationEnabled)

Option to enable animation in Instruction screen for ID.

setLowerWidthThresholdTolerance

public final Unit setLowerWidthThresholdTolerance(Float lowerWidthThresholdTolerance)

setMinBarcodeConfidence

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.

setMinMrzConfidence

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.

setMissingBarcodeTimeInterval

public final Unit setMissingBarcodeTimeInterval(Integer missingBarcodeTimeInterval)

setSeparateIdCardCaptureSequence

public final Unit setSeparateIdCardCaptureSequence(Boolean separateIdCardCaptureSequence)

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

setUpperWidthThresholdTolerance

public final Unit setUpperWidthThresholdTolerance(Float upperWidthThresholdTolerance)

setWrongDocumentTypeHandlingMode

public final Unit setWrongDocumentTypeHandlingMode(WrongDocumentTypeHandlingMode wrongDocumentTypeHandlingMode)

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

setWrongDocumentTypeWarningDelayInSec

public final Unit setWrongDocumentTypeWarningDelayInSec(Integer wrongDocumentTypeWarningDelayInSec)

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

writeToParcel

public abstract Unit writeToParcel(Parcel p0, Integer p1)