> ## 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でアプリケーションのホワイトラベルブランディング設定を取得します。カラー、フォント、角丸、ロゴURL、認証フローのUIオプションを確認できます。



ブランディング取得用プロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`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: <DIDIT_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.`

\</pre>



      
      

貼り付け先

## 概要APIキーから特定されるアプリケーションのホワイトラベルブランディングを返します。これは、[認証フロー](https://docs.didit.me/ja/console/white-label.md)でエンドユーザーに表示されるものと同じブランディングです。レスポンスには、カラー、フォント、角丸の半径、ロゴのURL、UI/UXのオプションが含まれます。## 使用する場面- **現在のテーマの読み取り**: 有効なカラーパレット、フォント、ロゴを表示または編集する前に取得します。
- **ブランディングの同期**: Diditのブランディングを自社の管理画面に反映します。## 注意事項- アプリケーションはAPIキーから特定されるため、パスパラメーターやクエリパラメーターはありません。
- `logo_square`、`logo_rectangular`、`logo_rectangular_dark`、`favicon`、`font_url`は読み取り専用です。ロゴは[ブランディングの更新](https://docs.didit.me/ja/management-api/customization/update.md)で画像をアップロードして設定します。
- `logo_rectangular_dark`はダークモード用の横長ロゴで、暗い背景上に表示されます。
  ダークモード用のロゴが設定されていない場合、またはお使いのアカウントで横長ロゴが表示されない場合は`null`になります。
- カスタムドメインとホワイトラベルメールはこのレスポンスに含まれ**ません**。これらは引き続きBusiness Consoleで管理します。## 権限APIキーには、アプリケーションのカスタマイズ設定を読み取る権限が必要です。## 関連項目- [ブランディングの更新](https://docs.didit.me/ja/management-api/customization/update.md)
- [Consoleでのホワイトラベル設定](https://docs.didit.me/ja/console/white-label.md)


## OpenAPI

````yaml ja/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キーから特定されたアプリケーションのホワイトラベルのブランディングを返します。色、フォント、角の丸み、ロゴの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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->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の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.