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

نظرة عامة

يُرجع كيان شركة واحدًا من كيان الشركة مفهرسًا بواسطة vendor_data.

متى تستخدمه

  • البحث عن حالة التحقق الحالية لشركة: يمنحك مخطط features أحدث حالة لكل ميزة من ميزات التحقق من الشركات (KYB) في نظرة واحدة.
  • عروض التفاصيل في واجهة الإدارة الخاصة بك.
  • تقييم المخاطر باستخدام العدادات الإجمالية وحالات الميزات.

ملاحظات

  • قيمة vendor_data في عنوان URL حساسة لحالة الأحرف.
  • يُرجع 404 إذا لم توجد شركة بقيمة vendor_data هذه.
  • تتحدّث العدادات الإجمالية (session_count وapproved_count وdeclined_count وin_review_count) في الوقت الفعلي عند اكتمال جلسات التحقق من الشركات (KYB).
  • تعكس الحقول المستمدة من السجل (legal_name وregistration_number وcountry_code) آخر جلسة تحقق من الشركات (KYB) مقبولة.

الأذونات

يجب أن يمنح الدور صلاحية read: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.

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

vendor_data
string
مطلوب

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

الاستجابة

تفاصيل الشركة الكاملة بما في ذلك البيانات الوصفية وبيانات الجلسة المجمعة.

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