Setting properties

Here is the updated table with Kotlin-like parameters and default values included in the description where applicable:

Parameter

Description

Required

mobileToken: String

Token associated with your account, to use the SDK.

✅

setPersonId(personId: String?)

User identifier for fraud profile identification purposes and to assist in the identification of Analytics logs in cases of bugs and errors.

❌

setDocumentCaptureFlow(documentSteps: Array<DocumentDetectorStep>)

Defines the document capture flow as explained.

✅

setCaptureStages(captureStages: Array<CaptureStage>)

Configures the requirements for each capture stage. Designed to make capture more flexible in cases where the user is unable to capture with all checks active, preventing them from getting stuck at this stage in their registration flow.

❌

setPopupSettings(show: Boolean)

Enables/disables the popups displayed before each document capture. Default: true.

❌

setLayout(layoutId: Int?)

❌

setStyle(styleResourceId: Int)

❌

setNetworkSettings(requestTimeout: Int)

Defines SDK's requests timeout. Default: 60 seconds.

❌

setLuminositySensorSettings(sensorLuminositySettings: SensorLuminositySettings?)

Defines the threshold between acceptable/unacceptable ambient brightness. Default: 5 lx. Set null to disable this sensor.

❌

setOrientationSensorSettings(sensorOrientationSettings: SensorOrientationSettings?)

Defines the threshold between correct/incorrect device orientation. Higher values make it more flexible. Default: 3 m/s². Set null to disable this sensor.

❌

setStabilitySensorSettings(sensorStabilitySettings: SensorStabilitySettings?)

Defines stability sensor settings. Default: 2000 ms and 0.5 m/s². Set null to disable this sensor.

❌

setProxySettings(proxySettings: ProxySettings)

❌

setPreviewSettings(previewSettings: PreviewSettings)

Enables/disables and configures the visualization of the performed capture, requesting the user's confirmation to proceed. Default: disabled.

❌

setCurrentStepDoneDelay(showDelay: Boolean, delay: Int)

Delays the activity after the completion of each step. This method can be used to display a success message on the screen itself after the capture, for example. Default: false.

❌

setMessageSettings(messageSettings: MessageSettings)

❌

setResolutionSettings(resolution: Resolution)

Allows you to set the capture resolution. Options: FULL_HD (1920 x 1080), QUAD_HD (2560 x 1440), ULTRA_HD (3840 x 2160). Default: FULL_HD.

❌

setCompressSettings(compressQuality: Int)

Configures the quality in the compression process. Expects values between 80 and 100, where 100 is the best quality compression. Default: 90.

❌

enableGoogleServices(enable: Boolean)

Enables/disables features of the SDK that consume Google Services. Default: true. Disabling is not recommended due to the loss of security.

❌

setUseDeveloperMode(use: Boolean)

Enables developer mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseAdb(use: Boolean)

Enables Android Debug Bridge (ADB) debugging mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseDebug(use: Boolean)

Allows using the app in debug mode when true. Not recommended for production; use only for testing. Default: false.

❌

setGetImageUrlExpireTime(expireTime: String)

Sets the time the image URL will last on the server until it expires. Accepts intervals like 30m (minutes), 24h (hours), 10d (days). Examples: 30m, 1h 10m, 10d. Default: 3h.

❌

setUploadSettings(uploadSettings: UploadSettings)

❌

setAllowedPassportCountriesList(countryList: Array<CountryCodeList>)

❌

Last updated 1 month ago

Setting properties

Here is the updated table with Kotlin-like parameters and default values included in the description where applicable:

Parameter

Description

Required

mobileToken: String

Token associated with your account, to use the SDK.

✅

setPersonId(personId: String?)

User identifier for fraud profile identification purposes and to assist in the identification of Analytics logs in cases of bugs and errors.

❌

setDocumentCaptureFlow(documentSteps: Array<DocumentDetectorStep>)

Defines the document capture flow as explained.

✅

setCaptureStages(captureStages: Array<CaptureStage>)

❌

setPopupSettings(show: Boolean)

Enables/disables the popups displayed before each document capture. Default: true.

❌

setLayout(layoutId: Int?)

Overrides the default SDK layout. Create a file in the layout folder of your project, copy this , and make the changes you want.

❌

setStyle(styleResourceId: Int)

Sets up a new style guideline for the SDK. Create a styles.xml file in your project with this and customize it.

❌

setNetworkSettings(requestTimeout: Int)

Defines SDK's requests timeout. Default: 60 seconds.

❌

setLuminositySensorSettings(sensorLuminositySettings: SensorLuminositySettings?)

Defines the threshold between acceptable/unacceptable ambient brightness. Default: 5 lx. Set null to disable this sensor.

❌

setOrientationSensorSettings(sensorOrientationSettings: SensorOrientationSettings?)

Defines the threshold between correct/incorrect device orientation. Higher values make it more flexible. Default: 3 m/s². Set null to disable this sensor.

❌

setStabilitySensorSettings(sensorStabilitySettings: SensorStabilitySettings?)

Defines stability sensor settings. Default: 2000 ms and 0.5 m/s². Set null to disable this sensor.

❌

setProxySettings(proxySettings: ProxySettings)

Defines proxy settings. Follow ). Default: null.

❌

setPreviewSettings(previewSettings: PreviewSettings)

Enables/disables and configures the visualization of the performed capture, requesting the user's confirmation to proceed. Default: disabled.

❌

setCurrentStepDoneDelay(showDelay: Boolean, delay: Int)

Delays the activity after the completion of each step. This method can be used to display a success message on the screen itself after the capture, for example. Default: false.

❌

setMessageSettings(messageSettings: MessageSettings)

Customizes messages displayed in the feedback label during the capture and analysis process. See the available attributes .

❌

setResolutionSettings(resolution: Resolution)

Allows you to set the capture resolution. Options: FULL_HD (1920 x 1080), QUAD_HD (2560 x 1440), ULTRA_HD (3840 x 2160). Default: FULL_HD.

❌

setCompressSettings(compressQuality: Int)

Configures the quality in the compression process. Expects values between 80 and 100, where 100 is the best quality compression. Default: 90.

❌

enableGoogleServices(enable: Boolean)

Enables/disables features of the SDK that consume Google Services. Default: true. Disabling is not recommended due to the loss of security.

❌

setUseDeveloperMode(use: Boolean)

Enables developer mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseAdb(use: Boolean)

Enables Android Debug Bridge (ADB) debugging mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseDebug(use: Boolean)

Allows using the app in debug mode when true. Not recommended for production; use only for testing. Default: false.

❌

setGetImageUrlExpireTime(expireTime: String)

Sets the time the image URL will last on the server until it expires. Accepts intervals like 30m (minutes), 24h (hours), 10d (days). Examples: 30m, 1h 10m, 10d. Default: 3h.

❌

setUploadSettings(uploadSettings: UploadSettings)

Configures document upload settings. The SDK flow will prompt the user to upload the document files instead of capturing them. Includes document type and quality checks. See . Default: disabled.

❌

setAllowedPassportCountriesList(countryList: Array<CountryCodeList>)

Restricts accepted passports to specific issuing countries. See the full list of country codes . Example: setAllowedPassportCountriesList(arrayOf(CountryCodesList.BRA)). Default: All countries.

❌

Last updated 1 month ago