更新白标品牌 API

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
}

概述

根据 API 密钥确定的应用，部分更新其白标品牌设置。发送 application/json 可修改颜色、字体、圆角半径和界面选项；发送 multipart/form-data 可上传 Logo。只有您包含的字段会被更改，其他内容保持不变。

适用场景

设置验证流程主题：设置品牌颜色、字体和圆角半径。
上传 Logo：设置方形 Logo、矩形 Logo 及其深色模式版本，以及网站图标（favicon）。
优化体验：设置公开应用名称、隐私政策 URL，以及跳过欢迎页、隐藏进度条等开关。

上传 Logo

以 multipart/form-data 发送 Logo：

image_square：宽高比 1:1。
image_rectangular：宽高比 2:1。
image_rectangular_dark：宽高比 2:1。深色模式使用的矩形 Logo，显示在深色背景上。
image_favicon：最大 500 KB。

image_square、image_rectangular 和 image_rectangular_dark 必须是 PNG、JPG 或 WebP 图片，长边至少 512 px，且最大为 1 MB。系统会拒绝 SVG 文件。响应会返回最终的 logo_square、logo_rectangular、logo_rectangular_dark 和 favicon URL。要删除 Logo，请将对应的 delete_logo_square、delete_logo_rectangular、delete_logo_rectangular_dark 或 delete_favicon 标志设为 true。删除深色模式 Logo 后，logo_rectangular_dark 的值为 null。如果同一请求既上传 Logo 又发送其删除标志，则以上传为准。上传被拒绝时，会返回 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 密钥确定，因此没有路径参数。
十六进制颜色支持 #RRGGBB 或 #RRGGBBAA。font_weight 必须是所选 font_family 可用的字重。
此处无法配置自定义域名和白标邮件。 请在 Business Console 中管理这些设置。

权限

API 密钥必须具有更新该应用自定义设置的权限。

​概述

​适用场景

​上传 Logo

​注意事项

​权限

​相关内容

授权

请求体

响应

概述

适用场景

上传 Logo

注意事项

权限

相关内容