الانتقال إلى المحتوى الرئيسي
GET
curl
استرجع إدخالات قائمة واحدة، من الأحدث إلى الأقدم، مع بحث اختياري. يطابق search جزءاً من قيمة الإدخال أو تسميته دون مراعاة حالة الأحرف، ويحصر reference_session_id النتائج في الإدخالات المأخوذة من جلسة تحقق واحدة. في قائمة الوجوه، يحدد metadata.face_image_source أي وجه من وجوه الجلسة يمثله كل إدخال، وتكون القيمة liveness عند غياب الحقل. تتضمن إدخالات الوجوه والمستندات روابط صور في metadata تنتهي صلاحيتها بعد وقت قصير من الاستدعاء. استرجع الإدخالات مرة أخرى للحصول على روابط جديدة بدلاً من تخزينها. يتلقى مفتاح API الذي لا يملك media: read القيمة null لتلك الروابط.

التفويضات

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.

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

list_uuid
string<uuid>
مطلوب

معرّف UUID للقائمة، كما تم إرجاعه بواسطة سرد القوائم أو إنشاء قائمة.

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

نص غير حساس لحالة الأحرف يجب أن يحتوي عليه value أو display_label الخاص بالمدخلة.

reference_session_id
string<uuid>

فقط الإدخالات المأخوذة من جلسة التحقق من الشخص هذه، على سبيل المثال لمعرفة أي من وجوهها مدرج بالفعل.

limit
integer
افتراضي:50

حجم الصفحة. القيمة الافتراضية 50. القيمة الأعلى من 1000000 تُرجع 400؛ والقيمة الصفرية أو السالبة أو غير الرقمية ترجع إلى 50.

النطاق المطلوب: 1 <= x <= 1000000
offset
integer
افتراضي:0

فهرس يستند إلى الصفر للعنصر الأول المراد إرجاعه. يُفضل اتباع next. القيمة التي تزيد عن 1000000 تُرجع 400؛ والقيمة السالبة أو غير الرقمية ترجع تلقائياً إلى 0.

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

الاستجابة

صفحة من المدخلات، الأحدث أولاً.

count
integer
مطلوب

العدد الإجمالي للإدخالات المطابقة للمرشحات.

النطاق المطلوب: x >= 0
next
string<uri> | null
مطلوب

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

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

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

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