> ## 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. # تحديث تخصيص العلامة البيضاء عبر Management API > حدّث العلامة البيضاء في Didit عبر Management API: غيّر الألوان والخطوط وأنصاف أقطار الحواف، وارفع الشعارات، واضبط خيارات واجهة التحقق. موجّه تحديث العلامة التجارية نسخ الموجّه إلى الحافظة \

\`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 الخاص بك. أرسل `application/json` لتغيير الألوان والخطوط ونصف أقطار الزوايا وخيارات الواجهة، أو `multipart/form-data` لرفع الشعارات. تُغيَّر الحقول التي تُضمّنها فقط، وتبقى بقية الحقول دون تعديل.## متى تستخدمه- **تخصيص التدفق**: حدّد ألوان علامتك التجارية وخطها ونصف أقطار زواياها. - **رفع الشعارات**: حدّد الشعار المربّع، والشعار المستطيل ونسخته للوضع الداكن، والأيقونة المصغّرة (favicon). - **ضبط التجربة**: حدّد اسم التطبيق العام، ورابط سياسة الخصوصية، وخيارات التبديل مثل تخطّي شاشة الترحيب أو إخفاء شريط التقدم.## رفع الشعاراتأرسل الشعارات بصيغة `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 بكسل للضلع الأطول، وبحجم لا يتجاوز **1 MB**. تُرفض ملفات SVG. تُعيد الاستجابة عناوين URL الناتجة للحقول `logo_square` و`logo_rectangular` و`logo_rectangular_dark` و`favicon`.لحذف شعار، أرسل علامة الحذف المطابقة `delete_logo_square` أو `delete_logo_rectangular` أو `delete_logo_rectangular_dark` أو `delete_favicon` بالقيمة `true`. بعد حذف شعار الوضع الداكن، يعيد الحقل `logo_rectangular_dark` القيمة `null`. إذا تضمّن الطلب الواحد رفعًا لشعار وأرسل علامة حذفه أيضًا، فالرفع هو الذي يُنفَّذ.يعيد رفعٌ مرفوض الاستجابة `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، ولا توجد معاملات مسار. - تقبل الألوان السداسية عشرية الصيغة `#RRGGBB` أو `#RRGGBBAA`. يجب أن يكون `font_weight` وزنًا متاحًا للخط `font_family` المحدد. - **لا يمكن ضبط النطاق المخصص وبريد العلامة البيضاء الإلكتروني من هنا.** أدِرهما في [Business Console](https://docs.didit.me/ar/console/white-label.md).## الأذوناتيجب أن يملك مفتاح API الإذن بتحديث التخصيص للتطبيق.## ذات صلة- [الحصول على العلامة التجارية](https://docs.didit.me/ar/management-api/customization/get.md) - [العلامة البيضاء في وحدة التحكم](https://docs.didit.me/ar/console/white-label.md) ## OpenAPI ````yaml ar/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: >- تحديث جزئي للعلامة التجارية الخاصة بالعلامة البيضاء للتطبيق. أرسل `application/json` لتغيير الألوان والخطوط ونصف القطر وخيارات واجهة المستخدم، أو `multipart/form-data` لتحميل صور الشعار. يتم تغيير الحقول التي تدرجها فقط. لا يمكن تعيين النطاق المخصص والبريد الإلكتروني بالعلامة البيضاء عبر هذا الـ endpoint — استخدم 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، بحجم 512 بكسل على الأقل على الجانب الطويل، وبحد أقصى **1 MB**. image_rectangular: type: string format: binary description: >- شعار مستطيل (نسبة العرض إلى الارتفاع 2:1). بتنسيق PNG أو JPG أو WebP، وبحجم 512 بكسل على الأقل في الجانب الطويل، وبحد أقصى **1 MB**. image_rectangular_dark: type: string format: binary description: >- شعار مستطيل للوضع الداكن (نسبة العرض إلى الارتفاع 2:1)، يظهر على خلفية داكنة. بتنسيق PNG أو JPG أو WebP، وبحجم 512 بكسل على الأقل في الجانب الطويل، وبحد أقصى **1 MB**. يُعاد كـ `logo_rectangular_dark`. image_favicon: type: string format: binary description: صورة الأيقونة المفضلة (Favicon). الحد الأقصى **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: >- جسم الطلب غير صالح. على سبيل المثال: لون سداسي عشري بتنسيق غير صحيح، أو عائلة خط أو وزن خط غير معروفين، أو حقل خاص بـ Business Console فقط (`domain` و `from_email` و `verify_domain` و `force_remove_domain` و `verify_email_domain` و `force_remove_email_domain` ونظائرها للقراءة فقط)، أو تحميل شعار ليس بصيغة PNG أو JPG أو WebP، أو يقل طول جانبه الأطول عن 512 بكسل، أو يتجاوز 1 ميجابايت، أو ذو نسبة عرض إلى ارتفاع غير صحيحة. يُرجع أيضاً عند تعيين `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: أقل من 512 px على الجانب الطويل value: image_rectangular: - >- Image must be at least 512 px on its long side. Got 400x200 image dimensions Logo too large: summary: أكثر من 1 MB 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: >- نص التحديث الجزئي للعلامة التجارية. قدّم الحقول التي تريد تغييرها فقط. تقبل الألوان السداسية عشرية التنسيق `#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 (مثل `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: رابط سياسة الخصوصية المعروض للمستخدم النهائي. 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: التأخير (بالثواني) قبل إعادة التوجيه إلى رابط الاستدعاء. 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`. إذا قام نفس طلب multipart أيضاً برفع `image_rectangular_dark`، فستكون الأولوية لعملية الرفع. delete_favicon: type: boolean description: عندما تكون `true`، تتم إزالة أيقونة الموقع (favicon) الحالية. 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.