Styles

The styles object customizes the look and feel of the VX verification experience. Use it in the Create Session request to override default UI settings.

Colors

Defines custom color palettes. Each key (e.g., custom-green) maps to an array of ten hexadecimal color values representing the shades for that color.

primaryColor

Specifies which color key from colors is used as the primary theme color.

primaryShade

Selects the shade index (0–9) from the primary color palette.

colorScheme

Sets the overall color scheme, either "light" or "dark".

logo_url

URL of a logo image displayed in the interface.

defaultRadius

Default border radius applied to components. Accepts preset values (xs, sm, md, lg, xl) or a custom string/number.

button.radius

Overrides the border radius specifically for buttons. Supports the same values as defaultRadius.

components.button.color

Hex value for the text color of primary filled buttons.

assets.icons.handoff.header.main

Defines a custom icon for the handoff header:

• alt – alternative text for the image.

• url – fallback image URL.

• srcset – provides higher‑resolution sources for "2x" and "3x" displays.

• width and height – dimensions in pixels. Icons must fit within a 100 × 100 space, though smaller sizes are allowed.

global.typography.font

Controls the font used across the experience:

• family – name of the font family.

• normal.url – URL to the font file. Any font type is accepted; the example uses a TTF file for demonstration.

• normal.format – format of the font file, such as "truetype".