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

نظرة عامة

يعيد هذا المسار ملف PDF واحدًا يحتوي على سجل التحقق الكامل لـ كيان المستخدم، ويُحدَّد المستخدم بالقيمة vendor_data. وهو المستند نفسه الذي تنتجه Console عبر User detail → Actions → Download PDF، لذلك يمكن لفرق الامتثال أتمتة عمليات التصدير بدلًا من النقر مرة لكل مستخدم. يتضمن التقرير:
  • صفحة غلاف تحتوي على ملخص الملف الشخصي (الاسم وتاريخ الميلاد والولايات المُصدِرة والبريد الإلكتروني والهواتف المعتمدة)، وآخر حالة لكل ميزة، وعدادات الجلسات، وفهرسًا بالجلسات المضمّنة.
  • تقرير كامل لكل جلسة مضمّنة، بترتيب زمني من الأقدم إلى الأحدث. وكل تقرير منها هو نفسه التقرير الذي يعيده Generate PDF لتلك الجلسة وحدها.

الجلسات المؤهلة والحد الأقصى

تُضمَّن فقط جلسات التحقق من المستخدمين (KYC) التي تكون في حالة Approved أو Declined أو In Review أو Kyc Expired. أما الجلسات في أي حالة أخرى، مثل Not Started أو In Progress أو Abandoned أو Expired وغيرها، فيتم تجاهلها. يقتصر التقرير على آخر 20 جلسة قابلة للإدراج. وإذا كان للمستخدم أكثر من ذلك، تُضمَّن أحدث 20 جلسة، ويذكر صفحة الغلاف عدد الجلسات الأقدم التي استُبعدت. استخدم List sessions مع تصفية حسب vendor_data عندما تحتاج إلى القائمة الكاملة بصيغة JSON.

الاستجابة

يكون متن الاستجابة ملف PDF نفسه (application/pdf)، وليس غلافًا بصيغة JSON ولا رابط تنزيل. ترويسة Content-Disposition تكون attachment; filename=user_<didit_internal_id>.pdf، حيث يمثل didit_internal_id معرّف Didit الثابت للمستخدم.

العلامة البيضاء

عند تفعيل تخصيص العلامة البيضاء في تطبيقك، يحمل الغلاف وكل تقرير جلسة شعارك ورابط سياسة الخصوصية الخاص بك بدلًا من علامة Didit التجارية، تمامًا كما في endpoint الخاصة بالجلسة الواحدة. اضبط ذلك من Console → Customization.

التخزين المؤقت وزمن الاستجابة

لا يُخزَّن أي شيء مؤقتًا: كل استدعاء يعيد إنشاء التقرير من البيانات الحالية، لذلك يعكس التقرير المطلوب بعد مراجعة يدوية قرار المراجِع. وقد ينتج استدعاءان ملفين مختلفين بايتًا ببايت، لذا احفظ الملف المُنزَّل إذا احتجت إلى نسخة ثابتة لا تتغير. يتم الإنشاء بشكل متزامن، ويُنزِّل كل صورة مخزّنة لكل جلسة مضمّنة، لذلك قد يستغرق إنشاء تقرير مستخدم لديه جلسات كثيرة ذات وسائط كثيفة عشرات الثواني. استخدم مهلة قراءة طويلة من جهة العميل (يُوصى بـ 120 ثانية) وقم ببث المتن إلى القرص. يتوقف الإنشاء عند ميزانية زمنية من جهة الخادم بدلًا من الاستمرار حتى ينفد صبر عميلك: وإذا بلغت هذه الميزانية، يظل التقرير يعيد ملف PDF صالحًا يحتوي على أحدث الجلسات، ويذكر الغلاف عدد الجلسات التي استُبعدت.

الشرطة المائلة في نهاية المسار

يحتوي المسار القياسي على شرطة مائلة في نهايته (…/generate-pdf/). يُخدَم الطلب الذي لا يتضمنها مباشرة بالاستجابة نفسها: لا توجد إعادة توجيه 301، فلا يحتاج أي عميل إلى تتبع عمليات إعادة التوجيه، ولا يحتاج curl إلى -L. استخدم المسار المنتهي بالشرطة المائلة كما في الأمثلة، فهو الشكل الذي تُظهره مواصفات OpenAPI وسجلاتك.

الأخطاء

الأمثلة

الصلاحيات

يمكن لأي مفتاح API نشط للتطبيق استدعاء نقطة النهاية هذه. مفاتيح API في Didit محصورة بالتطبيق، وليست محصورة بالأدوار: فالأدوار والأذونات في Console (Roles and permissions)، مثل read:users وغيرها، هي التي تحدد ما يمكن للشخص فعله في Console، ولا تُطبَّق على حركة مرور Management API. ولا يمكن للمفتاح تصدير إلا مستخدمي تطبيقه.

ذات صلة

  • Generate PDF: التقرير نفسه لجلسة واحدة
  • User KYC history: عرض جلسات المستخدم وفحصها بصيغة JSON
  • Export PDF & CSV: الجانب الخاص بالتصدير في Console لكلا النوعين
  • Get user: الملف الشخصي للمستخدم وخريطة الميزات بصيغة JSON

التفويضات

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). هذه هي نفس القيمة التي مررتها كـ vendor_data عند إنشاء جلسات المستخدم، وتتم مطابقتها تماماً كما أُرسلت. قم بترميزها وفق ترميز URL؛ فالقيمة التي تحتوي على / لا يمكن الوصول إليها عبر هذا المسار.

الاستجابة

مستند PDF المُصيَّر، يتم إرجاعه مباشرة كملف ثنائي application/pdf — لا يوجد غلاف JSON ولا إعادة توجيه عبر رابط تنزيل. يبدأ جسم الاستجابة ببايتات %PDF السحرية. احفظه في ملف بصيغة .pdf أو مرره مباشرة كبث إلى المتصل بك.

The response is of type file.

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