Design, Incode Studio

Customize with Studio

Use Studio to set your colors, logo, and button corner radius, preview the result across modules, and launch it to your users. For an overview of the Studio interface, see Incode Studio.

Info

Studio replaces the CSS Customization tab for accounts on UXv2. See CSS Customization to Incode Studio for migration information.

The first time you open Studio, you will be prompted to enter the basics for customization. This is called a theme. You can have one theme per client ID. You can choose to Skip for now to load Studio with Incode defaults and change any of these options later.

  1. In the left menu, click Studio.
  2. Click Get started.
  3. Enter your brand's Primary color in hex format.
  4. Upload two versions of your Logo: one for light backgrounds and one for dark backgrounds. Click Requirements to check that your image will work before you upload it.
  5. Click Continue.
  6. Select the module Studio shows in the preview. Your customization applies to all modules, and you can change the preview module at any time.
  7. Click Start customizing.

This setup does not need to be repeated. When you come back to Studio, it opens the most recently-saved version of your customization settings.

What you can customize

Each customization applies to every module and screen, not just the one you are previewing.

As you change settings, click Save as draft to keep your work. Each organization has one draft, and each save overwrites it. Version history keeps a record of every change and allows you to restore previous saves if needed. Studio never serves a draft to your users.

Upload one logo for Light background and one for Dark background. Studio picks the logo that matches the background of each screen. A verification flow includes both because the camera screens are dark and the form screens are light. If you only upload one logo, it appears on both backgrounds.

We recommend uploading SVG files for best quality results. Click Requirements in the Logo section of the Customization panel to see the full file requirements.

Note

If you do not upload your own logo, the Incode logo is used in the header. The color of this default logo will change based on the Brand color you select. Any logo file you upload will stay static when you change colors.

Corner radius

Sets the corner radius of buttons. This setting does not apply to cards, inputs, or capture frames. Use the drop-down to select one of eight values. The default is Medium.

Value Radius
None 0 px
X-Small 4 px
Small 8 px
Medium 16 px
Full Fully rounded

Verified by Incode tag

Toggle the Verified by Incode tag on or off to show or hide the tag in the footer of the experience. The tag is on by default.

For Web deployments, this setting is in CustomizationOptionsV2.json, so load that file alongside the CSS for the toggle to take effect.

Colors

Colors are token based. A token is a named value, such as --prizma-surface-brand, that Studio applies to a specific kind of element. The panel groups colors into five scales:

Group What it controls
Brand Primary buttons, links, active and selected states, loading indicators, default Incode logo header
Gray Surfaces, body text, and borders
Positive Success and verified states
Warning Caution states
Negative Errors, failures, and invalid input

Each group is a scale of stops, not a single value. Set the stop you care about, which for most accounts is Brand 500, and Studio derives the rest.

Token Glossary

Click Token Glossary in the Colors section to see how each color maps to the interface. The glossary has a section for each color group, and each section shows:

  • The group and what it controls, with its current color value.
  • The scale for the group, with a swatch for each stop.
  • The tokens in the group, organized by type: Surface, Text, Icon, and Border.
  • For each token, its name, the stop of the scale it uses, and the elements it affects.

For example, the Brand group includes these tokens:

Token Stop Where it is used
--prizma-surface-brand Brand 500 Primary button fill and badge fill
--prizma-text-brand Brand 500 Links and brand accent text
--prizma-text-link-hover Brand 300 Link hover state
--prizma-icon-brand Brand 500 Brand-tinted icons and active icon state

Use the glossary to find which group to change for a specific element. For example, to change the color of links, find the link tokens under Text and note the group and stop they use.

Some elements do not follow a color setting. If an element does not change when you change a color group, look for it in the Token Glossary. If no token lists the element, no color setting currently controls it.

The token names in the Token Glossary currently differ from the property names in incode-theme.css.

Restore an earlier version

Version history lets you go back to an earlier version of your customization. You can preview any version without changing your draft. Restoring a version replaces your current draft, and unsaved changes are lost.

  1. Click Version history in the header.
  2. Hover over the entry you want and click Preview studio-preview-icon.png.
  3. In the banner, click Exit preview to return to your draft, or click Restore this version.
  4. In the confirmation dialog, you can click Compare with current draft to review how the two versions differ.
  5. Click Restore. Studio replaces your current draft with the selected version and adds the restore to version history.

Restoring a version does not change what your users see until you launch it.

Launch your customization

Click Launch to choose your delivery path and build the customization package. Then, publish to hosted flows immediately, download the package and apply to your SDKs, or both.

Create the customization package

  1. Choose how to launch. Select the option that matches how your users reach your verification flow:
    • Hosted flows: Makes your customization live for your users across all flows right away. To go back, restore an earlier version.
    • Mobile or Web SDK: Builds a package for your developers to add to your app. Your users see no change until you ship an app release. To go back, include an earlier package in your next release.
    • Both: Lets you publish to hosted flows and download the SDK package from the same screen.
  2. Select your SDKs. If you chose Hosted flows, the dialog skips this step. Otherwise, select Mobile SDK, Web SDK, or both, and then click Continue. The Mobile SDK package is the same for iOS, Android, Flutter, React Native, and Cordova, and for every SDK version above the minimum. Studio shows the minimum SDK version for each platform.
  3. Confirm. Do one of the following:
    • For hosted flows, click Publish to make your customization live for your users immediately.
    • For SDK launches, click Download package and send the package to your developers.
    • If you chose Both, do both actions in either order. Publishing does not download the package, and downloading the package does not publish.

Info

Launching does not change an app that is already installed on a device. App stores do not allow an application to download executable code, so a native app reads its theme from the package built into it. Each time you change your customization and want the change to reach SDK users, launch again, download the new package, and ship a new app release.

Apply the package in your app

The package is scoped to the platforms you select, and it contains only the files those platforms read.

You select The package contains
iOS or Android CustomizationOptionsV2.json
Web incode-theme.css and CustomizationOptionsV2.json
iOS, when you set a logo assets/ios/light/incdOnboardingLogo.<ext> and assets/ios/dark/incdOnboardingLogo.<ext>
Android, when you set a logo assets/android/drawable/onboard_sdk_logo_header.<ext> and assets/android/drawable-night/onboard_sdk_logo_header.<ext>
Web, when you set a logo assets/logo-light.<ext> and assets/logo-dark.<ext>
Any platform README.txt

A native-only package contains no CSS file. The package is named incode-studio-theme-<platform>-<version>.zip. When you select more than one platform, it is named incode-studio-theme-<n>-platforms.zip.

How you use the files depends on the platform:

  • iOS and Android: Pass CustomizationOptionsV2.json to the SDK during setup. It contains light and dark values, so one file covers both display modes. The file does not contain image data, so add the logo files to your app through your platform's normal asset pipeline. Do not rename them. The light and dark logos share one file name and are told apart by folder, because the SDK looks up the logo by name. On Android, import SVG logos as vector drawables.
  • Web: Import incode-theme.css in your web app, and load CustomizationOptionsV2.json alongside it. The JSON carries settings the CSS cannot express and it includes both display modes.

Logo files keep the format you uploaded.

Warning

The Web CSS file contains values for one display mode only. Studio writes it for the mode selected in the preview theme switch when you launch. To get the CSS file for the other mode, switch the preview to that mode and launch again.