الانتقال إلى المحتوى الرئيسي
GET
curl
تُوصف أحداث توجيه سير العمل (WORKFLOW_BRANCH_EVALUATED, WORKFLOW_STATUS_NODE_REACHED) وتفاصيل details الخاصة بها في استرجاع الجلسة، والذي يمكنه أيضاً إرجاع الجدول الزمني لجلسة التحقق من المستخدمين (KYC) ضمن قرارها باستخدام ?include=events.

التفويضات

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.

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

sessionId
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق (session_id الذي تم إرجاعه بواسطة POST /v3/session/). يقبل معرّفات جلسات التحقق من المستخدمين (KYC) والتحقق من الشركات (KYB): يطابق الخادم المعرّف عبر كلا نوعي الجلسات. يجب أن يكون UUID صالح البنية؛ تؤدي القيمة غير صالحة البنية إلى عدم مطابقة المسار وإرجاع 404 بتنسيق HTML.

مثال:

"11111111-2222-3333-4444-555555555555"

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

limit
integer
افتراضي:50

الحد الأقصى لعدد الأحداث لكل صفحة. القيمة الافتراضية هي 50. أي قيمة أقل من 1 أو غير عددية تعود تلقائياً إلى 50؛ وأي قيمة تزيد عن 1,000,000 تُرجع 400.

النطاق المطلوب: 1 <= x <= 1000000
مثال:

50

offset
integer
افتراضي:0

عدد النتائج المراد تخطيها قبل أول نتيجة مُرجعة. القيمة الافتراضية هي 0؛ وأي قيمة سالبة أو غير رقمية تعود تلقائياً إلى 0، بينما تُرجع القيمة التي تتجاوز 1,000,000 الرمز 400. يُفضّل تتبّع عناوين URL في next وprevious.

النطاق المطلوب: 0 <= x <= 1000000
مثال:

0

ordering
string

تجاوز اختياري للترتيب. الترتيب الافتراضي هو -sent_at. مرّر اسم حقل نتيجة (على سبيل المثال sent_at أو created_at أو event_type أو feature_step أو step) للترتيب تصاعدياً، وأضف البادئة - للترتيب تنازلياً، وافصل بين الحقول المتعددة بفواصل. يتم تجاهل الحقول غير المعروفة.

مثال:

"sent_at"

الاستجابة

صفحة واحدة من أحداث الجلسة، الأحدث أولاً.

count
integer
مطلوب

العدد الإجمالي لأحداث الجلسة.

next
string<uri> | null
مطلوب

رابط URL للصفحة التالية، أو null في الصفحة الأخيرة.

previous
string<uri> | null
مطلوب

رابط URL للصفحة السابقة، أو null في الصفحة الأولى.

results
object[]
مطلوب
آخر تعديل في ٧ نوفمبر ٢٠٢٦