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

نظرة عامة

ينقل كيان الشركة بين الحالات ACTIVE وFLAGGED وBLOCKED. راجع دورة حياة الكيان للاطلاع على آلة الحالات الكاملة.

متى تستخدمه

  • حظر شركة خاضعة للعقوبات أو ثبت احتيالها.
  • وضع علامة على شركة بانتظار المراجعة اليدوية.
  • إلغاء الحظر بعد المعالجة.
  • نقل الإشارات الخارجية من أنظمة الامتثال لديك.

ملاحظات

  • القيم الصالحة: ACTIVE، FLAGGED، BLOCKED.
  • مرّر reason اختيارياً (بحد أقصى 1000 حرف) لتسجيل سبب تغيّر الحالة. يحتفظ Didit به في إدخال تغيير الحالة ضمن النشاط لدى الشركة في Business Console. لا يُسجَّل إلا عندما تتغير الحالة فعلاً.
  • تُرفض تلقائياً كل جلسات التحقق من الشركات (KYB) الجديدة وكل المعاملات الجديدة الخاصة بشركات BLOCKED، بما في ذلك حين تظهر هذه الشركات بصفتها طرفاً مقابلاً.
  • يُصدر business.status.updated مع previous_status وstatus. لا يتضمن webhook الحقل reason.

الإنفاذ

الأذونات

يمكن دائماً للسر الأساسي ومفاتيح مفاتيح API ذات الوصول الكامل استدعاء هذا endpoint. يحتاج المفتاح ذو الوصول المخصص إلى صلاحية الكتابة على الشركات (businesses). لا يمكن للمفتاح المقيَّد ببعض سير العمل أو بالجلسات المعتمدة الوصول إلى هذا endpoint. تحدد الأذونات والأدوار في 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
status
enum<string>
مطلوب

حالة دورة الحياة الجديدة. يؤدي استخدام BLOCKED أيضاً إلى إضافة vendor_data إلى قائمة الحظر الخاصة بالنظام.

الخيارات المتاحة:
ACTIVE,
FLAGGED,
BLOCKED
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>
آخر تعديل في ٧ نوفمبر ٢٠٢٦