الانتقال إلى المحتوى الرئيسي
PATCH
curl

نظرة عامة

تُحدِّث الحقول القابلة للتعديل في كيان الشركة. الحقول التي تُملأ من عمليات البحث في السجل (legal_name، وregistration_number، وcountry_code) تصبح للقراءة فقط بعد أول جلسة التحقق من الشركات (KYB) مقبولة.

متى تستخدمه

  • إعادة تسمية: عيّن display_name باسم أفضل للعروض الداخلية.
  • تحديث البيانات الوصفية: انقل شركة بين مستويات داخلية، وسجّل ملاحظة داخلية، وغيّر الوسوم.
  • تجاوز بيانات السجل (مع الحذر): التجاوزات مقبولة لكنها تُوسم في سجل التدقيق.

ملاحظات

  • لا يمكن تغيير vendor_data في عنوان URL عبر نقطة النهاية هذه.
  • يُرسل webhook باسم business.data.updated مع مصفوفة changed_fields.
  • يُسجَّل كل تعديل في النشاط الخاص بالشركة في Business Console. يُسجَّل تغيير status مع reason الاختياري (حتى 1000 حرف)، ويُسجَّل تغيير display_name أو legal_name أو registration_number أو country_code أو metadata كتحديث للملف التعريفي. لا يحمل حدث webhook business.status.updated الحقل reason.

الأذونات

يمكن دائماً للسر الأساسي ومفاتيح API ذات الوصول الكامل استدعاء نقطة النهاية هذه. يحتاج مفتاح ذو وصول مخصص إلى صلاحية الكتابة في الشركات (businesses). لا يستطيع مفتاح مقصور على بعض سير العمل أو على الجلسات المقبولة الوصول إلى نقطة النهاية هذه. تحدد الأدوار والأذونات في Console ما يمكن لعضو الفريق فعله داخل Console. لا تُقيَّم هذه الأذونات لطلبات مفاتيح API.

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

vendor_data
string
مطلوب

معرّفك الفريد للشركة (سلسلة نصية حرة، وليس UUID).

الجسم

application/json

نص التحديث الجزئي. قدّم فقط الحقول التي تريد تغييرها.

display_name
string | null

اسم العرض المألوف الظاهر في لوحة التحكم (له الأولوية على legal_name للعرض في واجهة المستخدم).

الاسم القانوني الرسمي من السجل أو الإدخال اليدوي.

registration_number
string | null

رقم تسجيل أو تأسيس الشركة.

country_code
string | null

دولة التأسيس (ISO 3166-1 alpha-2، مثل GB أو US).

status
enum<string>

حالة دورة حياة الشركة. يؤدي التعيين إلى BLOCKED تلقائياً إلى إضافة vendor_data إلى قائمة الحظر الخاصة بالنظام؛ بينما يؤدي التغيير من BLOCKED إلى إزالة هذا الإدخال من قائمة الحظر.

الخيارات المتاحة:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

كائن JSON عشوائي ترفقه بالشركة. يستبدل بالكامل البيانات الوصفية الحالية عند التحديث — قم بالدمج من جانب العميل إذا كنت تريد إضافة مفاتيح فقط.

reason
string | null

سبب تغيير الحالة. يُسجّل في قيد تغيير الحالة ضمن Activity الخاصة بالشركة في Business Console، فقط عندما تتغير الحالة فعلياً. لا تتضمنه أحداث webhook.

Maximum string length: 1000

الاستجابة

تم تحديث الشركة. يتم إرجاع سجل الشركة المحدث بالكامل.

تفاصيل الشركة الكاملة. يمتد من BusinessListItem بإضافة البيانات الوصفية وupdated_at.

didit_internal_id
string<uuid>

معرّف UUID الداخلي الثابت من Didit لهذه الشركة.

vendor_data
string | null

معرّفك الفريد لهذه الشركة (يتم تمريره عند إنشاء الجلسات). يمكن أن يكون هذا null في حال عدم تقديم معرّف بائع.

display_name
string | null

اسم عرض مخصص تم تعيينه بواسطتك

الاسم القانوني الرسمي من السجل أو الإدخال اليدوي

registration_number
string | null

رقم تسجيل أو تأسيس الشركة

country_code
string | null

دولة التأسيس (ISO 3166-1 alpha-2، مثل GB أو US).

effective_name
string | null

أفضل اسم متاح: display_name إذا كان محدداً، وإلا فـ legal_name

status
enum<string>

حالة دورة حياة سجل الشركة (ليست حالة جلسة). القيمة الافتراضية هي ACTIVE، وFLAGGED تميز السجل للمراجعة اليدوية، وBLOCKED تمنع إنشاء جلسات جديدة لقيمة vendor_data هذه.

الخيارات المتاحة:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

العدد الإجمالي لجلسات التحقق لهذه الشركة

approved_count
integer

عدد الجلسات المقبولة

declined_count
integer

عدد الجلسات المرفوضة

in_review_count
integer

عدد الجلسات قيد المراجعة

features
object

الحالة المجمعة لكل ميزة عبر جميع جلسات KYB الخاصة بهذه الشركة. المفتاح الوحيد حالياً هو KYB (حالة فحص الشركة في السجل). القيم المحتملة: Approved، Declined، In Review، Not Finished، Resub Requested.

features_list
object[]

البيانات نفسها مثل features، كمصفوفة مرتبة من كائنات {feature, status}.

last_session_at
string<date-time> | null

الطابع الزمني لأحدث جلسة

first_session_at
string<date-time> | null

الطابع الزمني للجلسة الأولى

last_activity_at
string<date-time> | null

الطابع الزمني لأحدث نشاط (تغيير الحالة، تحديث الجلسة، إلخ)

tags
object[]

العلامات المعيّنة لهذه الشركة

created_at
string<date-time>
metadata
object

بيانات وصفية مخصصة بتنسيق JSON أرفقتها بهذه الشركة. القيمة الافتراضية هي {}.

updated_at
string<date-time>
آخر تعديل في ٧ نوفمبر ٢٠٢٦