> ## 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のManagement APIでホワイトラベルのブランディングを更新。カラー、フォント、角丸を変更し、ロゴのアップロードや認証フローのUIオプション調整ができます。 ブランディング更新用プロンプト プロンプトをクリップボードにコピー \

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

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

Two content types:
\- application/json  -> change colors, fonts, radii and UI options
\- multipart/form-data -> upload logo images (image_square, image_rectangular, image_rectangular_dark, image_favicon)

PARTIAL update: only the fields you send are changed. The application is resolved from the API key (no path params).

JSON body fields:
\- Colors (hex '#RRGGBB' or '#RRGGBBAA'): 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
\- border_radius_panel, border_radius_buttons (integers >= 0)
\- font_family (Google Font name), font_weight (must be available for the family)
\- app_public_name (string|null), privacy_policy_url (string|null)
\- skip_welcome_screen, disable_login_with_didit, hide_progress_bar (boolean)
\- callback_seconds (integer >= 0)
\- delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark, delete_favicon (boolean) -> remove an existing logo; an upload sent in the same request wins over its delete flag

Logo upload (multipart/form-data) fields:
\- image_square (1:1)
\- image_rectangular (2:1)
\- image_rectangular_dark (2:1, the rectangular logo for dark mode; returned as logo_rectangular_dark)
\- image_favicon (max 500 KB)
Logo rules for image_square, image_rectangular and image_rectangular_dark: PNG, JPG or WebP (SVG is refused), at least 512 px on the long side, max 1 MB.

NOT allowed here (Business Console only): custom domain and white-label email.

curl (JSON):
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"}'

curl (logo upload):
curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'image_rectangular=@logo.png' \
-F 'image_rectangular_dark=@logo-dark.png' \
-F 'image_favicon=@favicon.ico'

Response 200: the full updated BrandingCustomization object (same shape as GET).

Failure modes:
\- 400: validation. Examples: { "color_primary": ["Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format."] }, { "image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"] }, { "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_square": ["File size should not exceed 1 MB"] }
\- 401 — missing/invalid x-api-key.

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

\
貼り付け先 ## 概要APIキーから特定されるアプリケーションのホワイトラベルブランディングを部分的に更新します。色、フォント、角の丸み、UIオプションを変更する場合は`application/json`を、ロゴをアップロードする場合は`multipart/form-data`を送信します。変更されるのはリクエストに含めたフィールドのみで、それ以外はそのまま維持されます。## 使用する場面- **フローのテーマ設定**: ブランドカラー、フォント、角の丸みを設定します。 - **ロゴのアップロード**: 正方形ロゴ、横長ロゴとそのダークモード版、ファビコンを設定します。 - **体験の調整**: 公開アプリ名、プライバシーポリシーのURL、ウェルカム画面のスキップや進捗バーの非表示などの切り替えを設定します。## ロゴのアップロードロゴは`multipart/form-data`で送信します。- `image_square`: アスペクト比1:1。 - `image_rectangular`: アスペクト比2:1。 - `image_rectangular_dark`: アスペクト比2:1。ダークモード用の横長ロゴで、暗い背景上に表示されます。 - `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が返されます。ロゴを削除するには、対応する`delete_logo_square`、`delete_logo_rectangular`、`delete_logo_rectangular_dark`、`delete_favicon`のフラグを`true`として送信します。 ダークモード用ロゴを削除すると、`logo_rectangular_dark`は`null`になります。 1つのリクエストでロゴのアップロードとその削除フラグの両方を送信した場合は、アップロードが優先されます。アップロードが拒否されると、フィールド名と理由を含む`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キーから特定されるため、パスパラメーターはありません。 - 16進数のカラーコードは`#RRGGBB`または`#RRGGBBAA`の形式に対応しています。`font_weight`には、選択した`font_family`で利用可能なウェイトを指定する必要があります。 - **カスタムドメインとホワイトラベルメールはここでは設定できません。**これらは[Business Console](https://docs.didit.me/ja/console/white-label.md)で管理してください。## 権限APIキーには、アプリケーションのカスタマイズを更新する権限が必要です。## 関連情報- [ブランディングの取得](https://docs.didit.me/ja/management-api/customization/get.md) - [Consoleでのホワイトラベル設定](https://docs.didit.me/ja/console/white-label.md) ## OpenAPI ````yaml ja/openapi-25.json PATCH /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/: patch: tags: - Customization summary: ブランディングのカスタマイズを更新 description: >- アプリケーションのホワイトラベルブランディングを部分更新します。色、フォント、角丸、UIオプションを変更するには`application/json`を、ロゴ画像をアップロードするには`multipart/form-data`を送信してください。指定したフィールドのみが変更されます。カスタムドメインとホワイトラベルメールはこのエンドポイントでは設定できません。これらはBusiness Consoleで設定してください。 operationId: update_customization requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BrandingCustomizationUpdate' examples: Update colors and font: summary: ブランドカラーとフォントを変更 value: color_primary: '#123456' color_button_1: '#2567FF' font_family: AR One Sans border_radius_buttons: 16 Update UI options: summary: 公開名とフローのオプションを変更 value: app_public_name: Acme Verify privacy_policy_url: https://acme.com/privacy skip_welcome_screen: true hide_progress_bar: true callback_seconds: 5 Remove a logo: summary: 現在の長方形ロゴを削除 value: delete_logo_rectangular: true Remove the dark-mode logo: summary: 現在のダークモード用ロゴを削除 value: delete_logo_rectangular_dark: true multipart/form-data: schema: type: object description: >- multipart/form-dataはロゴ画像のアップロードにのみ使用してください。上記のブランディングフィールドも、同じリクエスト内でフォームフィールドとして送信できます。 properties: image_square: type: string format: binary description: 正方形のロゴ(アスペクト比1:1)。PNG、JPGまたはWebP、長辺512px以上、最大**1 MB**。 image_rectangular: type: string format: binary description: 横長のロゴ（縦横比2:1）。PNG、JPG、WebPのいずれかで、長辺512px以上、**1 MB**以下です。 image_rectangular_dark: type: string format: binary description: >- ダークモード用の横長のロゴ（縦横比2:1）で、暗い背景上に表示されます。PNG、JPG、WebPのいずれかで、長辺512px以上、**1 MB**以下です。`logo_rectangular_dark`として返されます。 image_favicon: type: string format: binary description: ファビコン画像。最大**500 KB**。 example: image_rectangular: (binary PNG logo, 2:1) image_rectangular_dark: (binary PNG logo for dark mode, 2:1) image_favicon: (binary favicon) responses: '200': description: ブランディングを更新しました。ブランディングオブジェクト全体が返されます（変更したフィールドだけでなく、すべてのフィールド）。 content: application/json: schema: $ref: '#/components/schemas/BrandingCustomization' examples: Updated: value: 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 '400': description: >- リクエストボディが無効です。例: 不正な形式の16進カラーコード、不明なフォントファミリーまたはウェイト、Business Consoleでのみ使用できるフィールド (`domain`、`from_email`、`verify_domain`、`force_remove_domain`、`verify_email_domain`、`force_remove_email_domain`、およびそれらに対応する読み取り専用フィールド)、またはPNG、JPG、WebP画像ではない、長辺が512px未満である、1MBを超える、アスペクト比が正しくないロゴのアップロードです。カスタムドメインが設定されている状態で`disable_login_with_didit`を`false`に設定した場合にも返されます。 content: application/json: examples: Bad color: value: color_primary: - >- Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format. Bad logo: value: image_rectangular: - >- Image aspect ratio must be 2:1. Got 1024x1024 image dimensions Unsupported logo format: summary: PNG、JPG、WebPのいずれの画像でもありません（SVGなど） value: image_rectangular_dark: - Upload a PNG, JPG or WebP image. Logo too small: summary: 長辺が512px未満 value: image_rectangular: - >- Image must be at least 512 px on its long side. Got 400x200 image dimensions Logo too large: summary: 1MB超 value: image_square: - File size should not exceed 1 MB Console-only field: value: domain: - Manage this field in the Business Console. Bad font weight: value: font_weight: - >- Font weight 950 is not available for Inter. Available weights are: 100, 200, 300, 400, 500, 600, 700, 800, 900 '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 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"}' - lang: curl label: curl (logo upload) source: |- curl -X PATCH 'https://verification.didit.me/v3/customization/' \ -H 'x-api-key: YOUR_API_KEY' \ -F 'image_rectangular=@logo.png' \ -F 'image_rectangular_dark=@logo-dark.png' \ -F 'image_favicon=@favicon.ico' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.customization.update( image_rectangular=open("image_rectangular.jpg", "rb"), image_rectangular_dark=open("image_rectangular_dark.jpg", "rb"), image_favicon=open("image_favicon.jpg", "rb"), ) print(result) - lang: javascript label: Node.js source: |- import Didit, { fileFromPath } from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.customization.update({ image_rectangular: await fileFromPath("image_rectangular.jpg"), image_rectangular_dark: await fileFromPath("image_rectangular_dark.jpg"), image_favicon: await fileFromPath("image_favicon.jpg"), }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Update(ctx, didit.CustomizationUpdateParams{\n\tImageRectangular: didit.Some(didit.FileFromPath(\"image_rectangular.jpg\")),\n\tImageRectangularDark: didit.Some(didit.FileFromPath(\"image_rectangular_dark.jpg\")),\n\tImageFavicon: didit.Some(didit.FileFromPath(\"image_favicon.jpg\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.nio.file.Path; import me.didit.Didit; import me.didit.types.CustomizationUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.customization().update(CustomizationUpdateParams.builder() .imageRectangular(Path.of("image_rectangular.jpg")) .imageRectangularDark(Path.of("image_rectangular_dark.jpg")) .imageFavicon(Path.of("image_favicon.jpg")) .build()); System.out.println(result); - lang: php label: PHP source: |- customization->update([ 'image_rectangular' => File::fromPath('image_rectangular.jpg'), 'image_rectangular_dark' => File::fromPath('image_rectangular_dark.jpg'), 'image_favicon' => File::fromPath('image_favicon.jpg'), ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.customization.update( image_rectangular: Pathname("image_rectangular.jpg"), image_rectangular_dark: Pathname("image_rectangular_dark.jpg"), image_favicon: Pathname("image_favicon.jpg") ) 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.UpdateAsync(new CustomizationUpdateParams { ImageRectangular = FileUpload.FromPath("image_rectangular.jpg"), ImageRectangularDark = FileUpload.FromPath("image_rectangular_dark.jpg"), ImageFavicon = FileUpload.FromPath("image_favicon.jpg"), }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BrandingCustomizationUpdate: type: object description: >- ブランディングの部分更新ボディ。変更したいフィールドのみを指定してください。16進カラーは`#RRGGBB`または`#RRGGBBAA`を受け付けます。カスタムドメインとホワイトラベルメールはここでは受け付けません。 properties: color_primary: type: string description: 見出しとメインテキストの色です。 color_secondary: type: string description: 段落/セカンダリテキストの色。 color_background: type: string description: ページの背景色。 color_panel: type: string description: パネル/アクセントカラー。 color_panel_10: type: string description: 不透明度10%のパネルカラー。 color_on_panel_1: type: string description: パネル上の補助テキストの色。 color_on_panel_2: type: string description: パネル上のピル/バッジの色。 color_on_background: type: string description: 背景上のテキスト色。 color_button_1: type: string description: プライマリボタンの色。 color_button_2: type: string description: セカンダリボタンの色。 color_button_text_1: type: string description: プライマリボタンの文字色。 color_button_text_2: type: string description: セカンダリボタンのテキストの色。 color_pill_text: type: string description: ピル、入力欄、セレクターのテキスト色。 border_radius_panel: type: integer minimum: 0 description: パネルの角丸の半径(ピクセル単位)。 border_radius_buttons: type: integer minimum: 0 description: ボタンの角の半径(ピクセル)。 font_family: type: string description: 'Google Fontのフォントファミリー名(例: `Inter`、`AR One Sans`)。' font_weight: type: string description: 選択したフォントファミリーで利用可能なフォントウェイト（例：`regular`、`500`、`700`）。 app_public_name: type: string nullable: true description: 認証フローに表示される公開名です。 privacy_policy_url: type: string nullable: true description: エンドユーザーに表示されるプライバシーポリシーのURL。 skip_welcome_screen: type: boolean description: 最初のウェルカム画面をスキップします。 disable_login_with_didit: type: boolean description: >- Diditでログインする画面を表示せず、ゲストとして続行します。カスタムドメインが設定されている間は`false`に戻すことはできません（400）。 hide_progress_bar: type: boolean description: フロー中に進捗バーを非表示にします。 callback_seconds: type: integer minimum: 0 description: コールバックURLにリダイレクトするまでの遅延（秒）。 delete_logo_square: type: boolean description: '`true`の場合、現在の正方形ロゴを削除します。' delete_logo_rectangular: type: boolean description: '`true`の場合、現在の長方形ロゴを削除します。' delete_logo_rectangular_dark: type: boolean description: >- `true`の場合、現在のダークモード用ロゴを削除し、以後`logo_rectangular_dark`は`null`になります。同じマルチパートリクエストで`image_rectangular_dark`もアップロードした場合は、アップロードが優先されます。 delete_favicon: type: boolean description: '`true`の場合、現在のファビコンを削除します。' 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のDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.