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

نظرة عامة

يحذف هذا الـ endpoint كيانًا واحدًا أو أكثر من كيانات الشركات. تُحذف سجلات الشركات نهائيًا. أما جلسات التحقق من الشركات (KYB) فلا يشملها هذا الـ endpoint، وتبقى مع إزالة ارتباطها بالشركة. احذفها باستخدام حذف الجلسة. والمعاملات غير مشمولة أيضًا، ويمكنك حذفها باستخدام الحذف الدفعي للمعاملات.

متى تستخدمه

  • طلبات الحق في النسيان.
  • تنظيف الشركات التجريبية أثناء ضمان الجودة.
  • إلغاء توفير الشركات التي أُزيلت من منصتك.

ملاحظات

  • تقبل قائمة من قيم vendor_data أو قيم didit_internal_id.
  • تتسم العملية بـ idempotency: حذف شركة محذوفة بالفعل لا يُحدث أي تغيير.
  • تعيد الاستجابة عدد العناصر المحذوفة فقط، ولا تعيد تقريرًا لكل عنصر. القيم التي لم تطابق أي سجل تُتخطى دون إشعار.
  • يُصدر الحدث business.data.updated مع تعيين deleted_at.
  • تُحذف السجلات التي تملكها الشركة نفسها معها، وهي روابط الوسوم وسجل التعليقات وسجلات الجهاز والشبكة الخاصة بها.
  • أما السجلات التي تنتجها جلسة التحقق من الشركات (KYB) فلا تُحذف مع الشركة: بيانات سجل الشركات، والمستندات المرفوعة، ونتائج AML، وفحوص المستفيدين الحقيقيين والأشخاص الرئيسيين تتبع الجلسة، وتبقى حتى تحذف الجلسة نفسها.

البيانات في تقرير تنظيمي نهائي

إذا كانت أي شركة محددة جزءًا من حالة لها تقرير تنظيمي نهائي، فإن الطلب كله يعيد 409 ولا يُحذف أي شيء. تتضمن الاستجابة code: in_filed_report وتذكر كل تقرير:
احذف كل تقرير باستخدام حذف التقرير، ثم أعد الطلب نفسه.

عملية حذف قيد التنفيذ بالفعل

تُحذف الشركة بطلب واحد في كل مرة. إذا كان طلب آخر ما زال يحذف إحدى الشركات المحددة، ينتظر هذا الطلب بضع ثوانٍ كحد أقصى، ثم يعيد 409 مع code: subject_deletion_in_progress دون حذف أي شيء:
أعد الطلب نفسه بعد اكتمال الحذف الآخر. الشركة التي حذفها الطلب الآخر لن تطابق الطلب بعد ذلك، لذا لن يحذف الطلب المكرر إلا ما تبقى.

الأذونات

يجب أن يمنح الدور الإذن delete:businesses. ويُخصَّص هذا الإذن عادةً للدورين OWNER وADMIN.

ذات صلة

التفويضات

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.

الجسم

application/json

قدّم vendor_data_list، أو didit_internal_id_list، أو delete_all: true. الأسبقية عند إرسال عدة عناصر: delete_all > vendor_data_list > didit_internal_id_list (يُستخدم المحدد ذو الأسبقية الأعلى فقط).

vendor_data_list
string[]

المعرّفات الخاصة بك المراد حذفها، وتتم مطابقتها تماماً كما أُرسلت.

didit_internal_id_list
string<uuid>[]

معرّفات UUID الداخلية لـ Didit (didit_internal_id) المطلوب حذفها.

delete_all
boolean
افتراضي:false

إذا كانت القيمة true، فسيتم حذف كل شركة في التطبيق. لا يمكن دمجها مع محددات القائمة.

الاستجابة

تم حذف الشركات. يعيد عدد الصفوف التي تمت إزالتها فعلياً.

deleted
integer

عدد الشركات المحذوفة (يستثني قيم vendor_data التي لم تطابق أي شيء).

آخر تعديل في ٧ نوفمبر ٢٠٢٦