Skip to content
Go to Dashboard

Relay: Light, dark, and auto theme

Choosing a theme

The Relay verification experience can render in a light theme, a dark theme, or follow whatever the user’s own device is set to. There are three options:

ThemeWhat it does
autoFollows the browser’s color scheme preference, which usually mirrors the device setting. This is the default.
lightAlways renders the light theme, whatever the device prefers.
darkAlways renders the dark theme, whatever the device prefers.

Which one should you pick?

Leave it on auto if your own product already follows the device preference. The verification step will match whatever the rest of your interface is doing, and a user who runs their phone in dark mode will not get a bright flash partway through your flow.

Set it explicitly if your product is always light or always dark regardless of the device. Locking the theme keeps the verification consistent with your interface rather than with the operating system.

💡 Auto follows the device, not your site. If your site is dark by default but the user's device is set to light, auto renders the light theme. Set the theme explicitly if you need it to match your interface.

Where it is set

The theme is set by your integration when it starts the verification, not in the Persona Dashboard.

  • With the Embedded Widget, it is one of the options you pass when you create the widget.
  • With Hosted Flow, it is a query parameter on the hosted URL.

For native apps, theming is not currently documented for the iOS and Android SDKs. See Relay: iOS and Android.

Full technical documentation

The developer documentation is the source of truth for the option itself:

Plans Explained

Relay theme by plan

Startup ProgramEssential PlanGrowth PlanEnterprise Plan
Relay themeAvailableAvailableAvailableAvailable

Learn more about pricing and plans.

Was this article helpful?
Thanks for the feedback. It helps us improve these docs.