Skip to main content
Version: 11.3.0

Custom Branding

Custom Branding is a tab in Control Center Settings. On it, you customize the company identity, the logo and the background of the affected HYPR components.

MVP Feature

Some functionality is limited. This article is subject to change as the feature develops and we make improvements.

Other Methods

This page covers Control Center component branding and notification branding.

To customize the end-user verification screens in HYPR Affirm, use Affirm Studio (End User Screen Management) instead.

The following pages cover other ways to customize HYPR:

  • UI Management (Control Center Advanced Mode): customizing the HYPR Mobile App, web channel push notifications and Device Manager
  • Home Screen Widgets: configuring the mobile desktop icon
  • HYPR Passwordless Advanced Branding: customizing the desktop client
Feature Flag

The Custom Branding interface, including SMS notification branding and per-component branding toggles, requires the Custom Branding feature to be enabled for your tenant. If you do not see the Custom Branding tab in Control Center Settings, contact HYPR Support or your HYPR representative.

Custom Branding tab with the Company Identity and Logo and Background cards and the Enable Branding Settings For toggles

The tab holds the Company Identity, Logo & Background, HYPR Mobile App, Device Manager and Keycloak cards. One Save Configuration button at the bottom of the tab saves all of them. Clear Changes discards changes you haven't saved.

Company Identity​

To change the Company Identity, complete the following steps:

  1. Enter values in the Company Name and Support Email fields.
  2. Click Save Configuration at the bottom of the tab.

HYPR uses these values as your company identity in outbound communications, including Affirm SMS and Helpdesk SMS notifications. HYPR also uses the Support Email in Control Center device notification emails, so recipients reach your organization's own support contact.

SMS Notification Branding​

In HYPR 10.7.0 and later, administrators can brand the text messages sent for Affirm verification flows and Helpdesk operations with the Company Name. In the Company Identity section, the following toggles control whether text messages use your Company Name:

  • Affirm SMS Notifications: Uses your Company Name at the start of the OTP verification text message instead of "HYPR"
  • Affirm Helpdesk SMS Notifications: Uses your Company Name in the Helpdesk verification text message instead of "Your organization"
Company Identity card with Company Name filled in and the Affirm SMS Notifications and Affirm Helpdesk SMS Notifications toggles on

A Company Name is required to turn on either toggle. The message wording is otherwise fixed, and the manager or approver text message doesn't change. For the default text of each message, see SMS Notification Branding.

Email Notification Customization​

Control Center also supports customizing email notifications and their templates. Manage email templates on the separate Notification Settings tab in Control Center Settings. There you can manage templates, versions, activation and custom images for supported notification types.

Notification Settings tab listing email notification types with their templates and the Manage Templates button

For more information, including branding edits, template version history and custom image upload caching behavior, see Email Notification Customization.

Logo & Background​

To change the Logo & Background, complete the following steps:

  1. Set the Company Logo. It appears on the screens of each component you turn on in step 5.

    • To add a logo, drag the image onto the tile, or click Select File to open a file dialog on your local machine and choose an image. The tile accepts PNG, JPG or SVG files with a minimum resolution of 200x75.
    • To replace the logo, click Select a new file. To clear it, click Remove current image.
  2. Optional: Set the Company Logo (Light), a version of the logo for dark backgrounds, in the same way. If you don't set it, HYPR uses the Company Logo.

  3. Set the Company Background, the repeating background image behind HYPR modals. If this image is defined, it appears in front of the Solid Background Color.

    • To add a background image, drag the image onto the tile, or click Select File to open a file dialog on your local machine and choose an image.
    • To replace the background image, click Select a new file. To clear it, click Remove current image.
  4. Optional: In Solid Background Color # (Optional), type a hexadecimal color to fill the background behind the Company Background image. A swatch next to the field previews the color. Leave this value blank to use the default background color.

  5. Under Enable Branding Settings For, turn on each HYPR component that uses these settings:

    • Affirm: the Affirm requester and approver screens
    • Affirm Helpdesk: the Affirm Helpdesk portal
    • Keycloak
    • Device Manager
  6. Click Save Configuration at the bottom of the tab.

  7. Check your changes on each component:

    • Affirm: Browse to <your tenant URL>/cc/ui/idv

      Affirm welcome screen showing a custom company logo over a repeating custom background image
    • Device Manager: Open Device Manager from your profile in the upper right of the Control Center UI, or from a Magic Link

      Device Manager Login Methods page with a custom company logo in the header
    • Keycloak: Browse to <your tenant URL>

      Keycloak login page showing a custom company logo over a repeating custom background image

With the Affirm toggle on, the logo and background apply to every Affirm verification flow. To change screen content and styling for one flow, use an Affirm Studio kit.

HYPR Mobile App​

Configure basic messaging for the HYPR Mobile App.

HYPR Mobile App card with the registration success, login screen and color fields

The following table describes the HYPR Mobile App settings.

AttributeDescription
Registration Success TitleThe label at the top of the modal displayed to confirm a successful registration attempt.
Registration Success TextThe message text of the modal displayed to confirm a successful registration attempt.
Login Screen TitleThe label at the top of the modal displayed to prompt for an authentication attempt.
Login Screen SubtitleThe message text of the modal displayed to prompt for an authentication attempt.
Primary Color #The main color in hexadecimal format.
Secondary Color #The secondary color in hexadecimal format.

Device Manager​

Set up Device Manager with a custom message and redirect URL.

Device Manager card with the Prompt Message and Redirect URL fields

The following table describes the Device Manager settings.

AttributeDescription
Prompt MessageThe custom prompt message shown in the Device Manager home banner.
Redirect URLThe URL the user is redirected to after clicking Continue.

Keycloak​

Set custom links, the Affirm recovery flow URL and custom CSS for the Keycloak login pages.

The following table describes the Keycloak settings.

AttributeDescription
QR Code Page Custom Link Label 1 to 4The label of a custom link shown on the QR code page. Up to four links.
QR Code Page Custom Link Url 1 to 4The URL of the matching custom link on the QR code page.
Affirm Recovery Flow URLThe Affirm recovery flow URL that Keycloak uses.
Login Page Box Custom CSSCustom CSS for the login page box.
Login Page Input Custom CSSCustom CSS for the login page input fields.
Login Page Button Custom CSSCustom CSS for the login page buttons.
Login Page Header Border Custom CSSCustom CSS for the login page header border.
Login Page Error Custom CSSCustom CSS for login page errors.

Affirm Studio​

Affirm administrators can customize the content and branding on end-user verification screens with Affirm Studio, introduced in HYPR 10.3.0 as the End User Screen Management System. With Affirm Studio, administrators can do the following:

  • Screen-Specific Customization: Customize content for each verification step
  • Content Management: Control titles, descriptions, instructions and button labels
  • Branding Consistency: Apply company branding across all verification screens
  • API Integration: Control content programmatically through REST API endpoints

For more information, see Affirm Studio.