Following the acquisition, Onfido is now known as Entrust.Read more
Onfido LogoOnfido Logo

Developers

SDK UI Customization Guide

The latest Entrust IDV SDKs for mobile bring an updated design system for the SDKs' UI, which offers new customization options to integrators.

This guide lists the customization options offered via the SDK's theme interface.

For integration and customization of the Onfido Smart Capture SDKs, including the Onfido Web SDK, please refer to the Smart Capture SDK language and UI customization guide.

Preface - features not yet available

The SDK UI customization framework will introduce additional capabilities over time, with the following features shortlisted for upcoming releases in 2026:

  • Font and text style customization
  • Ability to align text and components across the screen
  • Ability to set individual left/right/up/bottom padding and border on text and components
  • Ability to change default images and icons
  • Ability to provide a custom spinner (currently only colors can be modified)

How to customize the SDK's UI

The SDK UI customization framework described in this guide has expanded its scope compared to its predecessor and introduces the following key features:

  • The same UI customization tokens can be used uniformly across all Entrust IDV SDKs (iOS, Android, React Native)
  • To simplify integration, UI customization tokens are affecting all related SDK screen elements
  • A comprehensive structure is provided to avoid undue duplication of keys and values
Example of color mapping

The framework will be extended to also apply to the Onfido Web and Flutter SDKs later in 2026.

The theme interface

Until a dedicated customization dashboard is introduced in Workflow Studio in 2026, the UI customization framework can be used via the SDK's theme configuration interface. This configuration object currently consists of the following major and optional parts:

  • mode: optionally set to either Light or Dark. Used to pre-select the SDK UI's theme
  • lightColors / darkColors: centralized color references that can automatically be used across the SDK's screens
  • android logoAndroid
  • ios logoiOS
  • react logoReact Native
  • kotlin
    1override fun onCreate(savedInstanceState: Bundle?) {
    2 ...
    3 EntrustIdv.start(
    4 ...
    5 configuration = Configuration(
    6 ...
    7 theme = Theme(
    8 ...
    9 mode = ThemeMode.Light,
    10 lightColors = mapOf(
    11 ColorTokens.BackgroundColorBrandDefault to "#FF00FF85",
    12 ColorTokens.ContentColorBase to "#0B1B0B",
    13 ),
    14 darkColors = mapOf(
    15 ColorTokens.BackgroundColorBrandDefault to "#0000FF85",
    16 ColorTokens.ContentColorBase to "#FF1CFF",
    17 ),
    18 ))
    19 )
    20}
    swift
    1EntrustIdv(
    2 ...
    3 configuration: .init(
    4 ...
    5 theme: .init(
    6 ...
    7 mode: ThemeMode.light,
    8 lightColors: [
    9 ColorTokens.backgroundColorBrandDefault: "#FF00FF85",
    10 ColorTokens.contentColorBase: "#0B1B0B"
    11 ],
    12 darkColors: [
    13 ColorTokens.backgroundColorBrandDefault: "#0000FF85",
    14 ColorTokens.contentColorBase: "#FF1CFF"
    15 ],
    16 ))
    17 )
    javascript
    1entrustIdv.start({
    2 ...
    3 configuration: {
    4 ...
    5 theme: {
    6 ...
    7 mode: ThemeMode.Light,
    8 lightColors: {
    9 backgroundColorBrandDefault: '#FF00FF85',
    10 contentColorBase: '#0b1c0b'
    11 },
    12 darkColors: {
    13 backgroundColorBrandDefault: '#0000FF85',
    14 contentColorBase: '#FF1cFF'
    15 }
    16 },
    17 }
    18});

    Details are provided in the Entrust IDV SDK integration guide.

    Base color selection and themes (lightColors / darkColors)

    To avoid repeating color override across multiple UI components, the SDK's lightColors / darkColors interface can be used to configure colors centrally. By modifying a color value in both colors sets, all component-level tokens derived from them will be affected. Integrators would then only need to use the component-specific overrides for exceptions to standard coloring patterns, such as for extra brand emphasis.

    For example, modifying the color set for the backgroundColorBrandDefault token in the lightColors and darkColors will apply that color to all component-specific tokens that are assigned the backgroundColorBrandDefault token, such as the background color of the primary button and spinner's main color. The mapping between the base tokens and component-specific areas is listed in the Components section below.

    The full list of available lightColors / darkColors tokens is listed in the Base colors section below.

    Unless predefined in the SDK's theme/mode configuration, the UI's theme (Dark or Light mode) is automatically determined by the SDK based on the device (or browser) settings. As such, the customization interface is mirrored for both themes for lightColors and darkColors. It is therefore critical to implement default colors for both lightColors and darkColors as the SDK will make use of both sets of colors across the experience (our capture screens are always rendered in dark mode).

    Base colors

    Base colors are divided in three categories:

    • content-color: affects the 'foreground' color of a component such as its text or icon
    • background-color: affects the color of the background or surface area of a component
    • border-color: affects the color of the outer line of a component

    Loading...


    Note:

    • Each token can be assigned a color value in hex format (e.g. '#FFFFFF' for white). Colors can also be provided as 8-character values to account for transparency (e.g. '#FFFFFF85' for white with 50% opacity/transparency)
    • Colors assigned to both light and dark themes should provide sufficient contrast for accessibility purposes. It is also recommended to provide sufficient differentiation for the hover and active color variants

    General Screen Background, Text & Border

    The overall screen background, overlay and border colors can be customized by modifying the base color tokens defined in the table below.

    Base Color TokenDescriptionLightDark
    backgroundColorSurfacePrimaryDefaultGeneral background color of the screen
    #22262C
    #FFFFFF
    backgroundColorSurfaceSecondaryDefaultSecondary background color used in media containers
    #E9ECF0
    #636670
    backgroundColorOverlayColor of the semi-transparent overlay visible over live capture screens and when a screen pop-up is shown
    #0A0D11CC
    #0A0D11CC

    Additionally, the color of the main text elements can be customized by modifying the following base color tokens:

    Base Color TokenDescriptionLightDark
    contentColorBaseColor of the body of text and titles
    #0A0D11
    #FFFFFF
    contentColorSubtleSecondary text color applied to field descriptions and supporting icons
    #53565C
    #FFD25C
    contentColorNegativeBaseDefaultText color used for input validation errors
    #D31127
    #FEC9C4
    contentColorPlaceholderColor used for placeholder text within input fields
    #63676D
    #92959B

    Note: The color of text or icons within particular components such as buttons or banners is driven by potentially more specific color tokens as defined in the following sections of this guide.

    Key Components

    This section presents the components available across the Entrust IDV SDK screens. If you require customization capabilities beyond the scope described in this document, please contact your Customer Success Manager.

    Buttons

    While the behavior of buttons is consistent across screens and platforms, colors are driven by a button's 'variant':

    VariantExample
    PrimaryPrimary Button
    SecondarySecondary button
    TertiaryTertiary button
    Negative SecondarySecondary-negative button
    Negative TertiaryTertiary-negative button

    The buttons are currently used in the following parts of the UI:

    Use CaseDescriptionVariant
    Button DockCall To Action buttons located in most screensprimary and secondary
    (Web SDK) Cross-deviceButton on the cross-device desktop QR code screen to display more informationtertiary
    (Web SDK) Cross-deviceButton on the cross-device mobile 'Confirmation' screen for "It's not me"negative-secondary
    (Web SDK) Cross-deviceButton on the cross-device mobile 'Confirmation' screen for "It's not me"negative-tertiary
    Navigation BarBack and Close buttonstertiary
    Intro screensButtons to control the playback of animation on instruction screensprimary

    Note: In the current SDK iteration, it is not possible to replace 'transparent' colors

    Loading...


    Button Dock

    Button Dock

    The button-dock is the container at the bottom of most screens that contains either one or two buttons. In addition to customizing the buttons as defined in the section above, the Button Dock has the following customization options:

    Base Color TokenDescriptionLightDark
    backgroundColorSurfacePrimaryDefaultSurface color behind/around the buttons
    #FFFFFF
    #22262C
    borderColorSeparatorColor of the upper border of the Button Dock
    #E9EBEF
    #53565C

    Note: The relative position of buttons (stacked or side-by-side) is automatically controlled by the width of the available screen area

    Navigation Bar

    The navigation-bar is the container at the top of screens that may contain the Back and Exit buttons. In addition to customizing the bottom as defined in the Buttons section, the Navigation Bar has the following customization options:

    Base Color TokenDescriptionLightDark
    backgroundColorSurfacePrimaryDefaultSurface color behind/around the buttons
    #FFFFFF
    #22262C
    borderColorSeparatorColor of the bottom border of the Navigation Bar
    #E9EBEF
    #53565C

    The banner component is used to callout key instructions or live feedback to the user across the UI flow.

    VariantUse Case
    infoUser callout on introduction or instruction screensInfo banner
    warningUser warning appearing during the capture experience or in confirmation screensWarning banner
    errorUser error appearing during the capture experience or in confirmation screensError banner

    Notes:

    • The icons currently used within the Banner component cannot be changed
    • Capture screens (live camera feeds) are always displayed in dark mode to provide an optimal user experience

    The banner component is composed of an overall border, a message and an optional icon.

    Loading...


    Spinner

    The spinner component is present on all loading and waiting screens of the SDK.

    Spinner
    Base Color TokenDescriptionLightDark
    backgroundColorBrandDefaultColor of the 'progress' section of the spinner
    #4462E4
    #4462E4
    backgroundColorNeutralSubtleDefaultColor of the 'track' section of the spinner
    #E9EBEF
    #3F454F
    contentColorSubtleColor of any possible supporting text
    #53565C
    #D6D8DB

    Note: On Android, the spinner component of the first loading screen (when the SDK is being initialized) only contains a 'progress' section.

    Status Icon Tile

    The icon-tile component is the large icon present on status screens. It exists in three main variants:

    Use CaseDescriptionVariantExample
    Confirmation Screen'Green tick' when the user has successfully completed a taskpositivePositive Icon
    Permissions ScreenIcon representing the required permission typeneutralNeutral Icon
    Error Screen'Red exclamation mark' shown on error screensnegativeNegative/Error Icon

    The icon and background colors can be customized for each variant:

    VariantBase Color TokenLightDark
    positivebackgroundColorPositiveSubtleDefault
    #D7F6C8
    #225123
    positivecontentColorPositiveBaseDefault
    #36860F
    #B2ED73
    neutralbackgroundColorNeutralSubtleDefault
    #E9EBEF
    #3F454F
    neutralcontentColorSubtle
    #53565C
    #D6D8DB
    negativebackgroundColorNegativeSubtleDefault
    #FFE4E1
    #942C2C
    negativecontentColorNegativeBaseDefault
    #D31127
    #FEC9C4

    Country Selector

    The country-select component is present on multiple screens to allow the end user to select a country from a dropdown list or by starting to type in the main input field. It is also used to select the phone number country prefix.

    Country Selection component

    Loading...


    Note: The country flags cannot be edited or replaced.

    Selection List

    The selection-list component is a custom button list intended to provide end users with multiple choices.

    Selection List
    Use CaseDescription
    Document TypeIn the context of Document and Proof of Address, presents the user with a list of document types to choose from
    Cross-Device Link MethodIn the context of cross-device in the Web SDK, selector of the 'link' method available
    Generic user choice screensMultiple additional use cases for which the user is given a non-hierarchical choice (e.g. eID selection)

    Note: The individual icons present in the list cannot currently be customized

    Text Input Field

    The text-input component is used across any screen or component that requires the user to provide a typed value.

    Loading...


    Checkbox

    The checkbox component is a composite element that contains the following sub-components:

    • The container which corresponds to the overall checkbox, offering the customization of the overall border and background colors
    • The checkbox itself. It is referred to by its two main states/variants: selected and unselected
    • The icon that corresponds to the 'tick' within the container
    • The label of the overall component
    • The description of the overall component
    Checkbox

    The component itself also follows the standard input states of default, active, hover, disabled and invalid

    Overall container

    StateBase Color TokenLightDark
    defaultbackgroundColorSurfacePrimaryDefault
    #FFFFFF
    #22262C
    activebackgroundColorSurfacePrimaryActive
    #FFFFFF
    #1F2328
    hoverbackgroundColorSurfacePrimaryHover
    #FFFFFF
    #21242A
    disabledbackgroundColorInputDefault
    #FFFFFF
    #22262C
    invalidbackgroundColorInputDefault
    #FFFFFF
    #22262C
    defaultborderColorSeparator
    #E9EBEF
    #53565C
    activeborderColorSeparator
    #E9EBEF
    #53565C
    hoverborderColorSeparator
    #E9EBEF
    #53565C
    disabledborderColorSeparator
    #E9EBEF
    #53565C
    invalidborderColorSeparator
    #E9EBEF
    #53565C

    selected and unselected Checkbox

    VariantStateBase Color TokenLightDark
    selecteddefaultbackgroundColorBrandDefault
    #4462E4
    #4462E4
    selectedactivebackgroundColorBrandActive
    #2F51E1
    #2F51E1
    selectedhoverbackgroundColorBrandHover
    #3A59E2
    #3A59E2
    selecteddisabledbackgroundColorDisabledDefault
    #E9EBEF
    #53565C
    selectedinvalidbackgroundColorNegativeBaseDefault
    #D31127
    #D31127
    selecteddefaultborderColorBrandDefault
    #4462E4
    #4462E4
    selectedactiveborderColorBrandActive
    #4462E4
    #4462E4
    selectedhoverborderColorBrandHover
    #4462E4
    #4462E4
    selecteddisabledborderColorDisabledDefault
    #E9EBEF
    #53565C
    selectedinvalidborderColorNegativeBaseDefault
    #D31127
    #D31127
    unselectedactivebackgroundColorInputDefault
    #FFFFFF
    #22262C
    unselecteddefaultbackgroundColorInputDefault
    #FFFFFF
    #22262C
    unselecteddisabledbackgroundColorInputDefault
    #FFFFFF
    #22262C
    unselectedhoverbackgroundColorInputDefault
    #FFFFFF
    #22262C
    unselectedinvalidbackgroundColorInputDefault
    #FFFFFF
    #22262C
    unselecteddefaultborderColorInputDefault
    #92959B
    #6F7277
    unselectedactiveborderColorInputActive
    #85898F
    #66696D
    unselectedhoverborderColorInputHover
    #8C8F95
    #6B6D72
    unselecteddisabledborderColorDisabledDefault
    #E9EBEF
    #53565C
    unselectedinvalidborderColorNegativeBaseDefault
    #D31127
    #D31127

    icon sub-component

    StateBase Color TokenLightDark
    defaultcontentColorBrandOnBrand
    #FFFFFF
    #FFFFFF
    activecontentColorBrandOnBrand
    #FFFFFF
    #FFFFFF
    hovercontentColorBrandOnBrand
    #FFFFFF
    #FFFFFF
    invalidcontentColorBrandOnBrand
    #FFFFFF
    #FFFFFF
    disabledcontentColorDisabledDefault
    #92959B
    #6F7277

    label sub-component

    StateBase Color TokenLightDark
    defaultcontentColorSubtle
    #0A0D11
    #FFFFFF
    disabledcontentColorDisabledDefault
    #92959B
    #6F7277

    description sub-component

    StateBase Color TokenLightDark
    defaultcontentColorBase
    #53565C
    #D6D8DB
    disabledcontentColorDisabledDefault
    #92959B
    #6F7277