API для обновления брендинга White label

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",
  "color_secondary": "#9DA1A1",
  "color_background": "#FFFFFF",
  "color_panel": "#2567FF",
  "color_panel_10": "#1A1A1A",
  "color_on_panel_1": "#9DA1A1",
  "color_on_panel_2": "#F4F4F6",
  "color_on_background": "#000000",
  "color_button_1": "#2567FF",
  "color_button_2": "#F8F8F8",
  "color_button_text_1": "#FFFFFF",
  "color_button_text_2": "#000000",
  "color_pill_text": "#111827",
  "border_radius_panel": 10,
  "border_radius_buttons": 16,
  "font_family": "AR One Sans",
  "font_weight": "400",
  "font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
  "logo_square": null,
  "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
  "logo_rectangular_dark": null,
  "favicon": null,
  "app_public_name": "Acme Verify",
  "privacy_policy_url": "https://acme.com/privacy",
  "skip_welcome_screen": true,
  "disable_login_with_didit": false,
  "hide_progress_bar": false,
  "callback_seconds": 3
}

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",
  "color_secondary": "#9DA1A1",
  "color_background": "#FFFFFF",
  "color_panel": "#2567FF",
  "color_panel_10": "#1A1A1A",
  "color_on_panel_1": "#9DA1A1",
  "color_on_panel_2": "#F4F4F6",
  "color_on_background": "#000000",
  "color_button_1": "#2567FF",
  "color_button_2": "#F8F8F8",
  "color_button_text_1": "#FFFFFF",
  "color_button_text_2": "#000000",
  "color_pill_text": "#111827",
  "border_radius_panel": 10,
  "border_radius_buttons": 16,
  "font_family": "AR One Sans",
  "font_weight": "400",
  "font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
  "logo_square": null,
  "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
  "logo_rectangular_dark": null,
  "favicon": null,
  "app_public_name": "Acme Verify",
  "privacy_policy_url": "https://acme.com/privacy",
  "skip_welcome_screen": true,
  "disable_login_with_didit": false,
  "hide_progress_bar": false,
  "callback_seconds": 3
}

Обзор

Выполняет частичное обновление White label брендинга для приложения, которое определяется по вашему API-ключу. Отправьте application/json, чтобы изменить цвета, шрифты, радиусы скругления и параметры интерфейса, или multipart/form-data, чтобы загрузить логотипы. Изменяются только поля, которые вы передаёте; всё остальное остаётся без изменений.

Когда использовать

Оформите сценарий: задайте цвета бренда, шрифт и радиусы скругления углов.
Загрузите логотипы: задайте квадратный логотип, прямоугольный логотип и его версию для тёмной темы, а также favicon.
Настройте работу интерфейса: задайте публичное название приложения, URL политики конфиденциальности и переключатели, например пропуск приветственного экрана или скрытие индикатора прогресса.

Загрузка логотипов

Отправляйте логотипы в формате multipart/form-data:

image_square: соотношение сторон 1:1.
image_rectangular: соотношение сторон 2:1.
image_rectangular_dark: соотношение сторон 2:1. Прямоугольный логотип для тёмной темы, который отображается на тёмном фоне.
image_favicon: не более 500 КБ.

image_square, image_rectangular и image_rectangular_dark должны быть изображениями в формате PNG, JPG или WebP, с длинной стороной не менее 512 px и размером не более 1 МБ. Файлы SVG не принимаются. В ответе возвращаются URL-адреса logo_square, logo_rectangular, logo_rectangular_dark и favicon. Чтобы удалить логотип, отправьте соответствующий флаг delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark или delete_favicon со значением true. После удаления логотипа для тёмной темы поле logo_rectangular_dark принимает значение null. Если в одном запросе загружается логотип и передаётся его флаг удаления, приоритет имеет загрузка. Отклонённая загрузка возвращает 400 с названием поля и причиной, например:

{"image_rectangular_dark": ["Upload a PNG, JPG or WebP image."]}
{"image_rectangular": ["Image must be at least 512 px on its long side. Got 400x200 image dimensions"]}
{"image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"]}
{"image_square": ["File size should not exceed 1 MB"]}

Примечания

Приложение определяется по API-ключу, поэтому параметры пути отсутствуют.
HEX-цвета принимаются в форматах #RRGGBB или #RRGGBBAA. Значение font_weight должно быть доступно для выбранного font_family.
Пользовательский домен и White label email здесь не настраиваются. Управляйте ими в Business Console.

Разрешения

API-ключ должен иметь право обновлять настройки приложения.

Связанные материалы

Авторизации

x-api-key

string

header

обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Тело

Тело частичного обновления брендинга. Передавайте только те поля, которые хотите изменить. Шестнадцатеричные цвета принимают #RRGGBB или #RRGGBBAA. Пользовательский домен и email в стиле White label здесь не принимаются.

color_primary

string

Цвет заголовков / основного текста.

color_secondary

string

Цвет абзаца / вторичного текста.

color_background

string

Цвет фона страницы.

color_panel

string

Цвет панели / акцентный цвет.

color_panel_10

string

Цвет панели при непрозрачности 10%.

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

Радиус скругления углов панели в пикселях.

Требуемый диапазон: x >= 0

border_radius_buttons

integer

Радиус скругления углов кнопки в пикселях.

Требуемый диапазон: x >= 0

font_family

string

Название семейства шрифтов Google Fonts (например, Inter, AR One Sans).

font_weight

string

Насыщенность шрифта, доступная для выбранного семейства (например, regular, 500, 700).

app_public_name

string | null

Публичное название, отображаемое в процессе верификации.

privacy_policy_url

string | null

URL политики конфиденциальности, отображаемый конечному пользователю.

skip_welcome_screen

boolean

Пропустить начальный экран приветствия.

Продолжить как гость вместо отображения экрана входа через Didit. Не может быть переключено обратно на false, пока настроен пользовательский домен (400).

hide_progress_bar

boolean

Скрыть индикатор прогресса во время прохождения сценария.

callback_seconds

integer

Задержка (в секундах) перед перенаправлением на URL обратного вызова.

Требуемый диапазон: x >= 0

delete_logo_square

boolean

Когда true, удаляет текущий квадратный логотип.

delete_logo_rectangular

boolean

Когда true, удаляет текущий прямоугольный логотип.

delete_logo_rectangular_dark

boolean

Когда true, удаляет текущий логотип для темной темы, после чего logo_rectangular_dark принимает значение null. Если в том же multipart-запросе также загружается image_rectangular_dark, приоритет отдается загрузке.

delete_favicon

boolean

Когда true, удаляет текущий favicon.

Ответ

Брендинг обновлён. Возвращается ПОЛНЫЙ объект брендинга (все поля, а не только изменённые).

Брендинг White label для приложения: цвета, шрифты, радиусы скругления, URL-адреса логотипов и параметры UI/UX. URL-адреса логотипов доступны только для чтения (они задаются путём загрузки изображений). Пользовательский домен и email в стиле White label не включены.

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

Только для чтения. Разрешённый URL таблицы стилей Google Fonts для выбранного семейства шрифтов.

logo_square

string | null

URL квадратного логотипа только для чтения. Загружается через image_square.

logo_rectangular

string | null

URL прямоугольного логотипа только для чтения. Загружается через image_rectangular.

logo_rectangular_dark

string<uri> | null

Только для чтения. Временный подписанный URL прямоугольного логотипа для тёмной темы, отображаемого на тёмном фоне. null, если тёмный логотип не задан или прямоугольные логотипы не отображаются для вашего аккаунта. Загрузите его через image_rectangular_dark.

favicon

string | null

URL фавикона только для чтения. Загружается через image_favicon.

app_public_name

string | null

privacy_policy_url

string | null

skip_welcome_screen

boolean

hide_progress_bar

boolean

callback_seconds

integer

Последнее изменение 7 ноября 2026 г.

​Обзор

​Когда использовать

​Загрузка логотипов

​Примечания

​Разрешения

​Связанные материалы

Авторизации

Тело

Ответ

Обзор

Когда использовать

Загрузка логотипов

Примечания

Разрешения

Связанные материалы