> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # 获取白标品牌定制 API > 通过 Didit 管理 API 读取应用的白标品牌设置：颜色、字体、圆角、Logo 地址及验证流程界面选项。 获取品牌设置提示词 将提示词复制到剪贴板 \

\`Goal: Read the white-label branding for the application tied to an API key.

Endpoint: GET https://verification.didit.me/v3/customization/
Auth header: x-api-key: 

No path or query params. The application is resolved from the API key.

Response 200: a BrandingCustomization object:
\- Colors: color_primary, color_secondary, color_background, color_panel, color_panel_10, color_on_panel_1, color_on_panel_2, color_on_background, color_button_1, color_button_2, color_button_text_1, color_button_text_2, color_pill_text (hex strings)
\- border_radius_panel, border_radius_buttons (integers)
\- font_family, font_weight, font_url (font_url is read-only)
\- logo_square, logo_rectangular, logo_rectangular_dark, favicon (read-only URLs; null when unset)
\- logo_rectangular_dark: the rectangular logo for dark mode; null when no dark logo is set or rectangular logos are not shown for your account
\- app_public_name, privacy_policy_url, skip_welcome_screen, disable_login_with_didit, hide_progress_bar, callback_seconds

Not included: custom domain and white-label email settings (Business Console only).

curl:
curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'

Failure modes:
\- 401 — missing/invalid x-api-key.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
粘贴到 ## 概述返回从您的 API 密钥解析出的应用的白标品牌设置，即终端用户在[验证流程](https://docs.didit.me/zh/console/white-label.md)中看到的同一套品牌设置。响应包括颜色、字体、圆角半径、Logo URL 以及 UI/UX 选项。## 使用场景- **读取当前主题**：在渲染或编辑前，获取当前生效的调色板、字体和 Logo。 - **同步品牌设置**：将 Didit 的品牌设置同步到您自己的管理后台。## 说明- 应用由 API 密钥确定，此接口没有路径参数或查询参数。 - `logo_square`、`logo_rectangular`、`logo_rectangular_dark`、`favicon` 和 `font_url` 为只读字段。如需设置 Logo，请通过[更新品牌设置](https://docs.didit.me/zh/management-api/customization/update.md)上传图片。 - `logo_rectangular_dark` 是深色模式下使用的矩形 Logo，显示在深色背景上。未设置深色 Logo，或您的账户不显示矩形 Logo 时，其值为 `null`。 - 自定义域名和白标邮件**不在**此响应中返回；这两项仍需在 Business Console 中管理。## 权限API 密钥必须具有读取该应用定制配置的权限。## 相关内容- [更新品牌设置](https://docs.didit.me/zh/management-api/customization/update.md) - [Console 中的白标设置](https://docs.didit.me/zh/console/white-label.md) ## OpenAPI ````yaml zh/openapi-25.json GET /v3/customization/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。 servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/customization/: get: tags: - Customization summary: 获取品牌定制 description: >- 返回根据 API 密钥解析的应用白标品牌定制信息：颜色、字体、边框圆角、logo URL 以及 UI/UX 选项。自定义域名和白标邮件设置仅在 Business Console 中管理，不属于此响应的一部分。 operationId: get_customization responses: '200': description: 应用的当前品牌定制。 content: application/json: schema: $ref: '#/components/schemas/BrandingCustomization' examples: Default branding: value: color_primary: '#000000' 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: 12 font_family: Inter font_weight: regular font_url: https://fonts.googleapis.com/css2?family=Inter logo_square: null logo_rectangular: null logo_rectangular_dark: null favicon: null app_public_name: Acme Verify privacy_policy_url: https://acme.com/privacy skip_welcome_screen: false disable_login_with_didit: false hide_progress_bar: false callback_seconds: 3 '403': description: API 密钥缺失、格式错误、已过期或作用域属于其他应用。密钥缺失返回 `403`；密钥错误、已撤销或已过期返回 `401`。 content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '429': description: 超出速率限制。请使用指数退避重试。 security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X GET 'https://verification.didit.me/v3/customization/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.customization.retrieve() print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.customization.retrieve(); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Retrieve(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.customization().retrieve(); System.out.println(result); - lang: php label: PHP source: |- customization->retrieve(); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.customization.retrieve puts result.to_h - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Customization.RetrieveAsync(); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BrandingCustomization: type: object description: >- 应用的白标品牌化：颜色、字体、圆角半径、徽标 URL 和 UI/UX 选项。徽标 URL 为只读（通过上传图片进行设置）。不包含自定义域名和白标邮件。 properties: color_primary: type: string color_secondary: type: string color_background: type: string color_panel: type: string color_panel_10: type: string color_on_panel_1: type: string color_on_panel_2: type: string color_on_background: type: string color_button_1: type: string color_button_2: type: string color_button_text_1: type: string color_button_text_2: type: string color_pill_text: type: string border_radius_panel: type: integer border_radius_buttons: type: integer font_family: type: string font_weight: type: string font_url: type: string nullable: true description: 只读。所选字体系列解析后的 Google Fonts 样式表 URL。 logo_square: type: string nullable: true description: 方形徽标的只读 URL。通过 `image_square` 上传。 logo_rectangular: type: string nullable: true description: 矩形徽标的只读 URL。通过 `image_rectangular` 上传。 logo_rectangular_dark: type: string format: uri nullable: true description: >- 只读。暗色模式矩形徽标的临时签名 URL，显示在深色背景上。当未设置暗色徽标或您的账户不显示矩形徽标时为 `null`。通过 `image_rectangular_dark` 上传。 favicon: type: string nullable: true description: 网站图标的只读 URL。通过 `image_favicon` 上传。 app_public_name: type: string nullable: true privacy_policy_url: type: string nullable: true skip_welcome_screen: type: boolean disable_login_with_didit: type: boolean hide_progress_bar: type: boolean callback_seconds: type: integer securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 您的应用 API 密钥，可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于 IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP 列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.