Skip to main content

builder

DocumentRecognition.Builder

ParameterFunctionRequired
mobileTokenClient key that identifies that the collected data comes from your application. If you have not yet received your mobile-token, contact support.Yes.
.setDocumentSteps(DocumentRecognitionStep[] documentSteps)Defines the document capture flow performed by the user. More information hereYes.
.setSandboxEnvironment()If this parameter is used in the constructor, the library will be configured to send data to the sandbox environment. If absent, requests are sent to the production environment.No.
.showIntroductionScreens(Boolean showIntroductionScreens)When "false" disables the document photo collection introduction screens that appear to the user.No. Default is "true".
.setShowSuccessScreen(Boolean showSuccessScreen)When "false" disables the success screen after photo collection.No. Default is "true".
.setBackgroundColor(String backgroundColor)Allows configuration of the background color of the SDK activities.No. Default is "#ffffff".
.setFontColor(String fontColor)Allows configuration of the font color and icons of the SDK activities.No. Default is "#000000".
.setFontFamily(FontFamily fontFamily)Allows configuration of the font of the SDK activities.No. If not provided, the default is FontFamily.open_sans. Available fonts: FontFamily.open_sans, FontFamily.futura, FontFamily.verdana, FontFamily.roboto, FontFamily.poppins and FontFamily.helvetica.
.setVisualConfiguration(VisualConfiguration. visualConfiguration)Used to customize the images shown to the user throughout the SDK execution.No.
.setTextConfiguration(TextConfiguration. textConfiguration)Used to customize the onboarding introductory screen texts shown to the user throughout the SDK execution.No.
.setSessionId(String sessionId)Used to define the key that identifies the session started in the SDK. It is used to track the entire flow traversed by the user in the FaceRecon execution through logs. This field accepts up to 255 characters.No.
.setLogLevel(DocumentRecognition.LogLevel logLevel)Used to customize the verbosity level of the SDK logs. Available levels: LogLevel.debug, LogLevel.info, LogLevel.warn, LogLevel.error and LogLevel.trace. Default is LogLevel.debug.No.

The VisualConfiguration Object

ParameterFunctionRequired
.setOnboardingDrawable(int onboarding_drawable, int onboarding_width)Used to configure the image shown to the user on the SDK onboarding screen. The onboarding_drawable parameter should reference the id of the image to be shown and onboarding_width is the desired display size of this image.No.
.setDocumentFullDrawable(int documentfull_drawable, int documentfull_width)Used to configure the image shown to the user on the SDK full CNH capture screen. The documentfull_drawable parameter should reference the id of the image to be shown and documentfull_width is the desired display size of this image.No.
.setDocumentFrontDrawable(int documentfront_drawable, int documentfront_width)Used to configure the image shown to the user on the SDK CNH and RG front capture screen. The documentfront_drawable parameter should reference the id of the image to be shown and documentfront_width is the desired display size of this image.No.
.setDocumentBackDrawable(int documentback_drawable, int documentback_width)Used to configure the image shown to the user on the SDK CNH and RG back capture screen. The documentback_drawable parameter should reference the id of the image to be shown and documentback_width is the desired display size of this image.No.
.setButtonBorderSize(int border_size)Used to configure the border width of the SDK buttons.No. Default is 1.
.setButtonShadow(boolean button_shadow)When set to false removes the shadow effect, default on android, used by the SDK buttons.No. Default is true.

The TextConfiguration Object

ParameterFunctionRequired
.setCustomText(CustomLabel label, String text)Used to configure the texts shown to the user on the SDK onboarding screenNo.