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

نظرة عامة

ينشئ صراحةً كيان الشركة قبل تشغيل أي جلسة التحقق من الشركات (KYB).

متى تستخدمه

  • تهيئة البيانات الوصفية مسبقاً (الشريك، والمستوى، والمعرّفات الداخلية) قبل أول جلسة التحقق من الشركات (KYB).
  • الترحيل من مزوّد KYB آخر مع قائمة شركات موجودة.
  • التسجيل للمعاملات فقط: أرسل المعاملات لشركة تحقّقت منها عبر عملية تتم دون اتصال.

ملاحظات

  • الحقل vendor_data مطلوب وفريد لكل تطبيق. تُرجع التكرارات خطأ تعارض، وللتحديث استخدم PATCH /v3/businesses/{vendor_data}/.
  • يمكن تهيئة الحقول المستمدة من السجل (legal_name وregistration_number وcountry_code)، لكنها ستُستبدل ببيانات السجل من أول جلسة التحقق من الشركات (KYB) المقبولة.
  • إذا تطابق country_code مع قائمة الدول الخطرة في تطبيقك، تُنشأ الشركة بحالة BLOCKED.
  • يُصدر business.data.updated.

الأذونات

يجب أن يمنح الدور الإذن create:businesses.

ذات صلة

التفويضات

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
string | null

معرّفك الفريد لهذه الشركة (سلسلة نصية حرة، وليس UUID). اختياري ولكنه موصى به بشدة. عند تقديمه، يجب أن يكون فريداً بين الشركات غير المحذوفة للتطبيق؛ وتتم مطابقته تماماً كما أُرسل.

display_name
string | null

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

Maximum string length: 255

الاسم القانوني الرسمي للشركة.

Maximum string length: 255
registration_number
string | null

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

Maximum string length: 100
country_code
string | null

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

Maximum string length: 10
status
enum<string>
افتراضي:ACTIVE

حالة دورة الحياة الأولية. القيمة الافتراضية هي ACTIVE.

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

كائن JSON عشوائي ترفقه بالشركة. القيمة الافتراضية هي {}.

الاستجابة

تم إنشاء الشركة. يتم إرجاع سجل الشركة بالكامل (نفس بنية الحصول على الشركة).

تفاصيل الشركة الكاملة. يمتد من 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>
آخر تعديل في ٧ نوفمبر ٢٠٢٦