> ## 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: الألوان والخطوط ونصف أقطار الحواف وروابط الشعارات وخيارات واجهة التحقق.



تعليمات الحصول على العلامة التجارية
        نسخ الموجّه إلى الحافظة



      
      

\<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/ar/console/white-label.md). تشمل الاستجابة الألوان والخطوط وأنصاف أقطار الحواف وروابط الشعارات وخيارات واجهة المستخدم وتجربة المستخدم.## متى تستخدمه- **قراءة السمة الحالية**: جلب لوحة الألوان والخط والشعارات النشطة قبل عرضها أو تعديلها.
- **مزامنة العلامة التجارية**: نسخ علامة Didit التجارية إلى واجهة الإدارة الخاصة بك.## ملاحظات- يُحدَّد التطبيق من مفتاح API، ولا توجد معاملات مسار أو معاملات استعلام.
- الحقول `logo_square` و`logo_rectangular` و`logo_rectangular_dark` و`favicon` و`font_url` للقراءة فقط. اضبط الشعارات برفع الصور في [تحديث العلامة التجارية](https://docs.didit.me/ar/management-api/customization/update.md).
- `logo_rectangular_dark` هو الشعار المستطيل للوضع الداكن، ويظهر على خلفية داكنة.
  تكون قيمته `null` عندما لا يكون شعار داكن مضبوطًا، أو عندما لا تُعرض الشعارات المستطيلة لحسابك.
- النطاق المخصص والبريد الإلكتروني بالعلامة البيضاء **غير** مشمولين في هذه الاستجابة، وتبقى إدارتهما في Business Console.## الأذوناتيجب أن يملك مفتاح API صلاحية قراءة التخصيص للتطبيق.## ذات صلة- [تحديث العلامة التجارية](https://docs.didit.me/ar/management-api/customization/update.md)
- [العلامة البيضاء في وحدة التحكم](https://docs.didit.me/ar/console/white-label.md)


## OpenAPI

````yaml ar/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:
        الألوان، والخطوط، ونصف قطر الحواف (border radii)، وعناوين 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: >-
        العلامة التجارية ذات العلامة البيضاء لتطبيق ما: الألوان والخطوط وأنصاف
        الأقطار وروابط الشعار وخيارات UI/UX. روابط الشعار للقراءة فقط (عيّنها عن
        طريق تحميل الصور). النطاق المخصص والبريد الإلكتروني للعلامة البيضاء غير
        مشمولين.
      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 التي تم حلها لمجموعة
            الخطوط المحددة.
        logo_square:
          type: string
          nullable: true
          description: رابط للقراءة فقط للشعار المربع. يتم الرفع عبر `image_square`.
        logo_rectangular:
          type: string
          nullable: true
          description: رابط للقراءة فقط للشعار المستطيل. يتم الرفع عبر `image_rectangular`.
        logo_rectangular_dark:
          type: string
          format: uri
          nullable: true
          description: >-
            للقراءة فقط. رابط موقّع مؤقت للشعار المستطيل للوضع الداكن، يُعرض على
            خلفية داكنة. `null` عند عدم تعيين شعار داكن أو إذا كانت الشعارات
            المستطيلة لا تُعرض لحسابك. ارفعه باستخدام `image_rectangular_dark`.
        favicon:
          type: string
          nullable: true
          description: >-
            رابط للقراءة فقط للأيقونة المفضلة (favicon). يتم الرفع عبر
            `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 الخاص بتطبيقك، من Developers -> API keys في Business Console.
        يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا
        شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات
        المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن
        المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم
        إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو
        الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير
        404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة
        بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL
        للصور ومقاطع الفيديو وملفات PDF كـ 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.