ブランディングカスタマイズ更新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キーから特定されるアプリケーションのホワイトラベルブランディングを部分的に更新します。色、フォント、角の丸み、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で管理してください。

権限

APIキーには、アプリケーションのカスタマイズを更新する権限が必要です。

関連情報

承認

x-api-key

string

header

必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

ブランディングの部分更新ボディ。変更したいフィールドのみを指定してください。16進カラーは#RRGGBBまたは#RRGGBBAAを受け付けます。カスタムドメインとホワイトラベルメールはここでは受け付けません。

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 Fontのフォントファミリー名(例: 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になります。同じマルチパートリクエストでimage_rectangular_darkもアップロードした場合は、アップロードが優先されます。

delete_favicon

boolean

trueの場合、現在のファビコンを削除します。

レスポンス

ブランディングを更新しました。ブランディングオブジェクト全体が返されます（変更したフィールドだけでなく、すべてのフィールド）。

アプリケーションのホワイトラベルブランディング：色、フォント、角の丸み、ロゴURL、UI/UXオプション。ロゴURLは読み取り専用です（画像をアップロードして設定します）。カスタムドメインとホワイトラベルメールは含まれません。

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

読み取り専用。選択したフォントファミリーに対応するGoogle FontsスタイルシートのURLです。

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

最終更新日 2026年11月1日

​概要

​使用する場面

​ロゴのアップロード

​注意事項

​権限

​関連情報

承認

ボディ

レスポンス

概要

使用する場面

ロゴのアップロード

注意事項

権限

関連情報