Skip to main content
This page documents the new Entri UI. It lists the whiteLabel properties the new UI supports. Everything below is configured under the whiteLabel object passed to entri.connectDomain(config).Entri Unify is built on this same new UI, so these properties also theme the Unify modal, including its selection screen. See Unify configuration for the Unify-specific details.For the full (legacy) reference, see Connect White Label.

​
whiteLabel object

The whiteLabel object lets you customize the Entri Connect UI to match your branding. All properties are optional — boolean flags default to false, and any property left unset falls back to Entri’s default. You may need an Enterprise level account for some properties to be available; contact your account manager with questions.
When true, hides all mentions of “Powered by Entri”.
Hides the customer’s logo on the initial screen (does not apply to the multi-domain initial screen).
​
boolean
Hides the company name across the flow.
An https URL. When set, it overrides the configured Application logo and uses this one instead. We recommend an SVG or PNG that is 1:1.
​
string
Sets a background color for the logo mask. Useful if your logo is white with a transparent background.
​
boolean
When true, removes the rounded mask/border applied over your logo.
​
boolean
When true, removes the sharing link functionality across the whole application.
​
boolean
Skips the congratulations screen shown after a successful domain configuration.
​
object
Colors, fonts, and dimensions. See theme below.
​
object
Per-screen behavior toggles. See customProperties below.
​
object
Text and copy overrides per locale. See customCopy below.

​
whiteLabel.theme Object

Customizes the colors, fonts, and dimensions of the modal to match your app’s branding.
​
string
Primary brand color (hex code). Applies to primary buttons and links. Recommended for quick theming.
​
string
Text color on primary elements (hex code). Applies to text on buttons. Recommended for quick theming.
​
string
Color scheme: "disabled" (light), "enabled" (dark), or "auto" (matches the system preference). Defaults to disabled.
​
string
The modal’s width.
​
string
Background color of the modal container.
​
string
Links color, to override HTML’s default blue.
​
string
Backdrop/overlay color. Use a transparent hsla or rgba value.
​
string
The border CSS styling for buttons, e.g. solid 1px #000.
​
string
The border-radius CSS styling for buttons, e.g. 5% or 10px.
​
string
The border-radius CSS styling for input fields, e.g. 8px.
​
string
camelCase alias of inputs.border.radius.
​
string
Overrides the modal font-family with a Google Font.
​
string
The font-family normal text weight, e.g. 400.
​
string
Sets the modal font-family from a system font stack (no external font fetch).
​
string
The font-family normal text weight, e.g. 400.
​
string
The font-family bold text weight, e.g. 600.

​
whiteLabel.customProperties Object

Changes behaviors related to specific elements or a screen’s behavior.
​
string
A valid CSS selector (e.g. #entri-container) for the target element where the Entri Connect UI should be embedded. If null, the flow opens in a modal.
​
boolean
Enables the go-to-manual link on the initial screen. Closes the modal and adds authenticateManuallyClicked: true to the onEntriClose event.
​
boolean
Prevents the manual screen from being shown. Adds manualScreenDisabled: true to the onEntriClose event.
​
boolean
Disables the Existing Records override prompt and confirms automatically.
​
boolean
Displays the terms of service on the Provider Login screen.
​
boolean
Hides the “Change provider” feature.
​
boolean
Disables the Forward Link (forward-to-a-colleague) feature.
​
boolean
Hides the “go to manual” text copy on the Provider Login screen.

​
whiteLabel.customCopy Object

Customizes texts along the flow to match your brand’s tone or when the default copy doesn’t fit your use case. Translations are keyed by locale; the en locale is required and all missing translations fall back to English.
​
string
Sets the subtitle’s translation text for the specific locale.
​
string
Sets the Provider Login introduction’s translation text for the specific locale. Accepts the {PROVIDER} replacement token. Supports <strong></strong> for bold.
​
boolean
Disables opening the documentation URL set in the manualSetupDocumentation configuration property. Commonly combined with the onEntriManualSetupDocumentationClick event to trigger a custom JS function.
​
string
Sets the step-by-step-guide translation text for the specific locale. Supports <link></link> tags for triggering JS functions (useful for chatbots): enclose the call-to-action text in <link></link> and catch the onEntriManualSetupDocumentationClick event.
​
string
Sets the Congratulations title’s translation text for the specific locale. Accepts the {DOMAIN} replacement token. Supports <strong></strong> for bold.
​
string
Sets the Congratulations description’s translation text for the specific locale. Accepts the {USER} and {DOMAIN} placeholders. Supports <strong></strong> for bold.
​
string
Sets the Congratulations button call-to-action’s translation text for the specific locale. Supports <strong></strong> for bold.
Locales are codes such as en, es, fr, etc. If no matching translation is found for the locale in use, Entri’s default text is used. See the full list of supported locales in the configuration reference.

​
White label code example