> For the complete documentation index, see [llms.txt](/llms.txt).

# Whitelabel

Embedded Wallets supports whitelabeling with application branding for a consistent user experience. You can customize three different aspects:

- **UI elements:** Customize the appearance of modals and components
- **Branding:** Apply your brand colors, logos, and themes
- **Translations:** Localize the interface for your users

info

All of these settings can be easily managed directly from the Embedded Wallets dashboard. Once you update your branding, or UI preferences there, the changes will automatically apply to your integration.

![Branding page on the MetaMask Developer Dashboard](/img/embedded-wallets/whitelabel/modal/branding.png)

note

This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the **Growth Plan**. You can use this feature in Web3Auth Sapphire Devnet network for free.

## Customizing the Web3Auth sign-in screens[​](#customizing-the-web3auth-sign-in-screens "Direct link to Customizing the Web3Auth sign-in screens")

For defining custom UI, branding, and translations for your brand during Embedded Wallets instantiation, you just need to specify an additional parameter within the `Web3AuthOptions` object called `whiteLabel`. This parameter takes object called `WhiteLabelData`.

### `WhiteLabelData`[​](#whitelabeldata "Direct link to whitelabeldata")

- Table
- Interface

| Parameter        | Description                                                                                                                                                          |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appName?         | Display name for the app in the UI.                                                                                                                                  |
| logoLight?       | App logo to be used in dark mode. It accepts a URL in String as a value.                                                                                             |
| logoDark?        | App logo to be used in light mode. It accepts a URL in String as a value.                                                                                            |
| defaultLanguage? | Language which will be used by Web3Auth, app will use browser language if not specified. Default language is Language.EN. Checkout Language for supported languages. |
| mode?            | Theme mode for the sign-in modal. Choose between ThemeModes.AUTO, ThemeModes.LIGHT or ThemeModes.DARK background modes. Default value is ThemeModes.AUTO.            |
| theme?           | Used to customize the theme of the sign-in modal. It accepts HashMap as a value.                                                                                     |
| appUrl?          | URL to be used in the Modal. It accepts a URL in String as a value.                                                                                                  |
| useLogoLoader?   | Use logo loader. If logoDark and logoLight are null, the default Web3Auth logo will be used for the loader. Default value is false.                                  |

```
data class WhiteLabelData(
    var appName: String? = null,
    var appUrl: String? = null,
    var logoLight: String? = null,
    var logoDark: String? = null,
    var defaultLanguage: Language? = Language.EN,
    var mode: ThemeModes? = null,
    var useLogoLoader: Boolean? = false,
    var theme: HashMap<String, String?>? = null
)

```

### `name`[​](#name "Direct link to name")

The name of the application. This will be displayed in the key reconstruction page.

#### 

Standard screen **without** any change

![Standard screen without any change](/assets/images/whitelabel-web3auth-openlogin-theme1-896362b715c0f7324f7cf39e784d3c5c.png)

#### 

Name changed to `Formidable Duo`

![Name changed to Formidable Duo](/assets/images/whitelabel-web3auth-openlogin-theme2-a05a1b2998ac4f470b25d69a2610980c.png)

  
### `logoLight` & `logoDark`[​](#logolight--logodark "Direct link to logolight--logodark")

The logo of the application. Displayed in dark and light mode respectively. This will be displayed in the key reconstruction page.

#### 

`logoLight` on dark mode

![logoLight on dark mode](/assets/images/whitelabel-web3auth-openlogin-logo-light-dc8b10a3125f44faa0fafeeb0e646e0b.png)

#### 

`logoDark` on light mode

![logoDark on light mode](/assets/images/whitelabel-web3auth-openlogin-logo-dark-52289aa1ccb299e8acfd6c3ea1cf1b86.png)

  
### `defaultLanguage`[​](#defaultlanguage "Direct link to defaultlanguage")

Default language will set the language used on all OpenLogin screens. The supported languages are:

- `en` - English (default)
- `de` - German
- `ja` - Japanese
- `ko` - Korean
- `zh` - Mandarin
- `es` - Spanish
- `fr` - French
- `pt` - Portuguese
- `nl` - Dutch
- `tr` - Turkish

![default Language screen](/assets/images/whitelabel-web3auth-openlogin-language-73edccdb50344cd84746f04fcbf92b35.png)

  
### `dark`[​](#dark "Direct link to dark")

Can be set to `true` or `false` with default set to `false`.

  
#### 

For Light: `dark: false`

![light theme](/assets/images/whitelabel-web3auth-openlogin-light-fc03591b15a4150268aa198c9aeb7a3c.png)

#### 

For Dark: `dark: true`

![dark theme](/assets/images/whitelabel-web3auth-openlogin-dark-43e011bb3d7b7ef1314d9e38124f4f8a.png)

  
### `theme`[​](#theme "Direct link to theme")

Theme is a record of colors that can be configured. As of, now only `primary` color can be set and has effect on OpenLogin screens (default primary color is `#0364FF`). Theme affects icons and links. Examples below.

#### 

Standard color `#0364FF`

![Theme is a record of colors that can be configured.](/assets/images/whitelabel-web3auth-openlogin-theme1-896362b715c0f7324f7cf39e784d3c5c.png)

#### 

Color changed to `#D72F7A`

![Theme affects icons and links.](/assets/images/whitelabel-web3auth-openlogin-theme2-a05a1b2998ac4f470b25d69a2610980c.png)

  
### Example[​](#example "Direct link to Example")

Usage

```
web3Auth = Web3Auth(
  Web3AuthOptions(
    clientId = getString(R.string.web3auth_project_id),
    web3AuthNetwork = Web3AuthNetwork.SAPPHIRE_MAINNET,
    redirectUrl = "{YOUR_APP_PACKAGE_NAME}://auth",
    // Optional whitelabel object
    whiteLabel = WhiteLabelData(
      appName = "Web3Auth Sample App",
      appUrl = null,
      logoLight = null,
      logoDark = null,
      defaultLanguage = Language.EN, // EN, DE, JA, KO, ZH, ES, FR, PT, NL, TR
      mode = ThemeModes.DARK, // LIGHT, DARK, AUTO
      useLogoLoader = true,
      theme = hashMapOf(
        "primary" to "#229954"
      )
    )
  ),
  this
)

```