إدارة كيانات الشركات (KYB) عبر API

تتم إدارة جميع كيانات الشركات عبر ستة endpoint عامة ضمن /v3/businesses/. تقدّم لك هذه الصفحة شرحاً مفاهيمياً، وللاطلاع على مخططات الطلب والاستجابة كاملةً راجع مرجع API.

قائمة الشركات

GET /v3/businesses/ قائمة مقسّمة إلى صفحات بالشركات التابعة لتطبيقك، مع تصفية حسب الحالة والبحث والدولة ونطاق التاريخ.

curl -G https://verification.didit.me/v3/businesses/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "status=ACTIVE" \
  --data-urlencode "country_code=GBR" \
  --data-urlencode "page_size=50"

الحصول على شركة

GET /v3/businesses/{vendor_data}/ استرجع شركة واحدة باستخدام vendor_data.

curl https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY"

إنشاء شركة

POST /v3/businesses/create/ أنشئ شركة مسبقاً قبل بدء أي جلسة للتحقق من الشركات (KYB):

curl -X POST https://verification.didit.me/v3/businesses/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "biz-acme",
    "display_name": "Acme Corp",
    "country_code": "GBR",
    "metadata": { "partner": "Acme Holdings" }
  }'

تُرجع خطأ تعارض إذا كانت هناك شركة بقيمة vendor_data نفسها موجودة بالفعل. استخدم PATCH لتحديث شركة موجودة.

تحديث شركة

PATCH /v3/businesses/{vendor_data}/ حدّث حقول الملف التعريفي القابلة للتعديل. الحقول المشتقة من عمليات البحث في السجلات (legal_name وregistration_number وcountry_code) تكون للقراءة فقط بعد التحقق، لكن يمكن تجاوزها، وتُعلَّم عمليات التجاوز في سجل التدقيق. الحقول القابلة للتعديل: display_name وmetadata وtags. للقراءة فقط بعد التحقق: جميع الحقول المشتقة من السجلات، والعدادات المجمّعة، وخريطة features.

curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "tier": "enterprise" } }'

يُطلق business.data.updated.

تغيير الحالة

PATCH /v3/businesses/{vendor_data}/update-status/ انقل شركة بين الحالات ACTIVE وFLAGGED وBLOCKED.

curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/update-status/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "BLOCKED",
    "reason": "Sanctioned subsidiary detected in ownership chain"
  }'

من → إلى	المحفّز الشائع
`ACTIVE` → `FLAGGED`	انتقلت جلسة التحقق من الشركات (KYB) إلى `In Review`، أو ظهر تنبيه في مراقبة AML المستمرة، أو طابقت قاعدة معاملات
`ACTIVE` → `BLOCKED`	كيان خاضع للعقوبات مؤكَّد، أو إدخال يدوي في قائمة الحظر
`FLAGGED` → `ACTIVE`	أنهى المحلل المراجعة
`BLOCKED` → `ACTIVE`	رفع حظر يدوي بعد المعالجة

يُطلق business.status.updated.

حذف الشركات (دفعة واحدة)

POST /v3/businesses/delete/ احذف شركة واحدة أو أكثر. تُحذف سجلات الشركات نهائياً. لا يشمل هذا الـ endpoint جلسات التحقق، فهي تبقى مع فك ارتباطها بالشركة، واحذفها باستخدام حذف الجلسة. المعاملات غير مشمولة أيضاً، واحذفها من الـ Console.

curl -X POST https://verification.didit.me/v3/businesses/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "vendor_data": ["biz-acme", "biz-alpha", "biz-beta"] }'

تتسم هذه العملية بخاصية idempotency، فحذف شركة محذوفة مسبقاً لا يُحدث أي تغيير.

نموذج الأذونات

تخضع جميع endpoints /v3/businesses/* لنطاق إذن المورد businesses:

الدور	list	get	create	update	update-status	delete
OWNER	✅	✅	✅	✅	✅	✅
ADMIN	✅	✅	✅	✅	✅	✅
COMPLIANCE_OFFICER	✅	✅	❌	✅	✅	❌
DEVELOPER	✅	✅	✅	❌	❌	❌
READER	✅	✅	❌	❌	❌	❌

راجع الأدوار والأذونات.

أحداث webhook التي تُطلقها هذه العمليات

العملية	Webhook
`create`	`business.data.updated`
`update`	`business.data.updated` مع `changed_fields`
`update-status`	`business.status.updated`
`delete`	`business.data.updated` مع تعيين `deleted_at`

الخطوات التالية

نموذج البيانات

مرجع كامل للحقول.

API القائمة

مخطط GET /v3/businesses/.

API الإنشاء

مخطط POST /v3/businesses/create/.

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

نظرة عامة

الأسعار

سير العمل والتحقق

المراجعة والعمليات

الكيانات (المستخدمون والشركات)

الإعدادات والتخصيص

الأمان والامتثال

Didit Academy

الموارد

إدارة كيانات الشركات (KYB) عبر API

قائمة الشركات

الحصول على شركة

إنشاء شركة

تحديث شركة

تغيير الحالة

حذف الشركات (دفعة واحدة)

نموذج الأذونات

أحداث webhook التي تُطلقها هذه العمليات

الخطوات التالية

نموذج البيانات

API القائمة

API الإنشاء

​قائمة الشركات

​الحصول على شركة

​إنشاء شركة

​تحديث شركة

​تغيير الحالة

​حذف الشركات (دفعة واحدة)

​نموذج الأذونات

​أحداث webhook التي تُطلقها هذه العمليات

​الخطوات التالية

نموذج البيانات

API القائمة

API الإنشاء

قائمة الشركات

الحصول على شركة

إنشاء شركة

تحديث شركة

تغيير الحالة

حذف الشركات (دفعة واحدة)

نموذج الأذونات

أحداث webhook التي تُطلقها هذه العمليات

الخطوات التالية