> ## 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/ko/console/white-label.md)에서 최종 사용자에게 표시되는 브랜딩과 같습니다. 응답에는 색상, 글꼴, 테두리 반경, 로고 URL, UI/UX 옵션이 포함됩니다.## 사용 시기- **현재 테마 읽기** - 렌더링하거나 수정하기 전에 활성 팔레트, 글꼴, 로고를 가져옵니다.
- **브랜딩 동기화** - Didit 브랜딩을 자체 관리자 UI에 그대로 반영합니다.## 참고 사항- 애플리케이션은 API 키를 기준으로 확인되며, 경로 파라미터나 쿼리 파라미터는 없습니다.
- `logo_square`, `logo_rectangular`, `logo_rectangular_dark`, `favicon`, `font_url`은 읽기 전용입니다. 로고를 설정하려면 [브랜딩 업데이트](https://docs.didit.me/ko/management-api/customization/update.md)에서 이미지를 업로드하세요.
- `logo_rectangular_dark`는 다크 모드에서 어두운 배경에 표시되는 직사각형 로고입니다.
  다크 로고가 설정되지 않았거나 계정에 직사각형 로고가 표시되지 않으면 `null`입니다.
- 커스텀 도메인과 화이트 라벨 이메일은 이 응답에 **포함되지 않으며**, Business Console에서 계속 관리합니다.## 권한API 키에 애플리케이션의 커스터마이징을 읽을 수 있는 권한이 있어야 합니다.## 관련 문서- [브랜딩 업데이트](https://docs.didit.me/ko/management-api/customization/update.md)
- [Console의 화이트 라벨](https://docs.didit.me/ko/console/white-label.md)


## OpenAPI

````yaml ko/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: >-
        Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본
        키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며
        특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나
        만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된
        IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를
        벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write
        권한이 없는 키는 세션 링크와 token을 null로 수신합니다.
        https://docs.didit.me/console/api-keys 를 참고하십시오.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.