Update Branding - Didit Documentation

curl -X PATCH 'https://verification.didit.me/v3/customization/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"color_primary": "#123456", "font_family": "AR One Sans"}'

{
  "color_primary": "#123456",
  "font_family": "AR One Sans",
  "border_radius_buttons": 16,
  "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
  "app_public_name": "Acme Verify",
  "skip_welcome_screen": true
}

PATCH

customization

curl -X PATCH 'https://verification.didit.me/v3/customization/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"color_primary": "#123456", "font_family": "AR One Sans"}'

{
  "color_primary": "#123456",
  "font_family": "AR One Sans",
  "border_radius_buttons": 16,
  "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
  "app_public_name": "Acme Verify",
  "skip_welcome_screen": true
}

Overview

Partial-updates the white-label branding for the application resolved from your API key. Send application/json to change colors, fonts, radii and UI options, or multipart/form-data to upload logos. Only the fields you include are changed — everything else is left untouched.

When to use it

Theme the flow — set your brand colors, font and corner radii.
Upload logos — set the square logo, rectangular logo and favicon.
Tune the experience — set the public app name, privacy policy URL, and toggles like skipping the welcome screen or hiding the progress bar.

Uploading logos

Send logos as multipart/form-data:

image_square — 1:1 aspect ratio, max 1 MB
image_rectangular — 2:1 aspect ratio, max 1 MB
image_favicon — max 500 KB

Allowed image types are png, jpg, jpeg and webp. The response returns the resulting logo_square, logo_rectangular and favicon URLs. To remove a logo, send the matching delete_logo_square, delete_logo_rectangular or delete_favicon flag as true.

Notes

The application is resolved from the API key — there are no path parameters.
Hex colors accept #RRGGBB or #RRGGBBAA. font_weight must be a weight available for the selected font_family.
Custom domain and white-label email are not configurable here. Manage those in the Business Console.

Permissions

The API key must be able to update customization for the application.

Authorizations

x-api-key

string

header

required

Body

Partial branding update body. Provide only the fields you want to change. Hex colors accept #RRGGBB or #RRGGBBAA. Custom domain and white-label email are not accepted here.

color_primary

string

Headers / primary text color.

color_secondary

string

Paragraph / secondary text color.

color_background

string

Page background color.

color_panel

string

Panel / accent color.

color_panel_10

string

Panel color at 10% opacity.

color_on_panel_1

string

Support text color on panels.

color_on_panel_2

string

Pill / badge color on panels.

color_on_background

string

Text color on background.

color_button_1

string

Primary button color.

color_button_2

string

Secondary button color.

color_button_text_1

string

Primary button text color.

color_button_text_2

string

Secondary button text color.

color_pill_text

string

Text color for pills, inputs and selectors.

border_radius_panel

integer

Panel corner radius in pixels.

Required range: x >= 0

border_radius_buttons

integer

Button corner radius in pixels.

Required range: x >= 0

font_family

string

Google Font family name (e.g. Inter, AR One Sans).

font_weight

string

Font weight available for the selected family (e.g. regular, 500, 700).

app_public_name

string | null

Public name shown in the verification flow.

privacy_policy_url

string | null

skip_welcome_screen

boolean

Skip the initial welcome screen.

Continue as guest instead of showing the login-with-Didit screen.

hide_progress_bar

boolean

Hide the progress bar during the flow.

callback_seconds

integer

Delay (seconds) before redirecting to the callback URL.

Required range: x >= 0

delete_logo_square

boolean

When true, removes the current square logo.

delete_logo_rectangular

boolean

When true, removes the current rectangular logo.

delete_favicon

boolean

When true, removes the current favicon.

Response

Branding updated. The full branding object is returned.

White-label branding for an application: colors, fonts, radii, logo URLs and UI/UX options. Logo URLs are read-only (set them by uploading images). Custom domain and white-label email are not included.

color_primary

string

color_secondary

string

color_background

string

color_panel

string

color_panel_10

string

color_on_panel_1

string

color_on_panel_2

string

color_on_background

string

color_button_1

string

color_button_2

string

color_button_text_1

string

color_button_text_2

string

color_pill_text

string

border_radius_panel

integer

border_radius_buttons

integer

font_family

string

font_weight

string

font_url

string | null

Read-only. Resolved Google Fonts stylesheet URL for the selected family.

logo_square

string | null

Read-only URL of the square logo. Upload via image_square.

logo_rectangular

string | null

Read-only URL of the rectangular logo. Upload via image_rectangular.

favicon

string | null

Read-only URL of the favicon. Upload via image_favicon.

app_public_name

string | null

privacy_policy_url

string | null

skip_welcome_screen

boolean

hide_progress_bar

boolean

callback_seconds

integer

Get Branding List Webhook Destinations

⌘I

​Overview

​When to use it

​Uploading logos

​Notes

​Permissions

​Related

Authorizations

Body

Response

Overview

When to use it

Uploading logos

Notes

Permissions

Related