الانتقال إلى المحتوى الرئيسي
POST
curl
أنشئ قائمة لتطبيقك. لا يمكن إنشاء سوى قوائم allowlist وcustom: تُنشئ Didit قائمة الحظر الخاصة بالنظام واحدة لكل نوع إدخال، وتضيف إليها عبر إنشاء إدخال. اختر entry_type بعناية: لا يمكن تغييره لاحقاً، وهو يحدد طريقة التحقق من كل قيمة عند إضافتها. راجع القوائم لمعرفة ما يفعله كل نوع من أنواع القوائم.

التفويضات

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
name
string
مطلوب

اسم القائمة. يجب أن يختلف عن اسم كل قائمة أخرى في التطبيق، بما في ذلك قوائم النظام.

Required string length: 1 - 255
list_type
enum<string>
مطلوب

allowlist أو custom. ويتم رفض blocklist بالرمز 400.

الخيارات المتاحة:
allowlist,
custom
entry_type
enum<string>
مطلوب

ما تحتويه القائمة: face، أو document (رقم المستند)، أو phone، أو email، أو ip_address (عنوان IP أو نطاق CIDR)، أو device_fingerprint، أو wallet_address، أو bank_account، أو country (وفق معيار ISO 3166-1 alpha-3)، أو user أو business (الخاص بـ vendor_data لديك)، أو key (أي سلسلة نصية). وتحدد هذه القيمة كيفية التحقق من صحة قيم الإدخال ومطابقتها. لا يمكن تغييرها لاحقاً.

الخيارات المتاحة:
face,
document,
phone,
email,
ip_address,
device_fingerprint,
wallet_address,
bank_account,
country,
user,
business,
key
description
string
افتراضي:""

وصف اختياري بنص حر.

الاستجابة

تم إنشاء القائمة.

قائمة حظر، أو قائمة سماح، أو قائمة مخصصة لتطبيق واحد.

uuid
string<uuid>
مطلوب

معرّف القائمة. استخدمه كـ list_uuid في endpoints الخاصة بالقوائم والمدخلات، وكقيمة لشرط قاعدة سير عمل أو قاعدة معاملة مع value_type: "list".

name
string
مطلوب

اسم القائمة، وهو فريد بين قوائم التطبيق.

Maximum string length: 255
description
string
مطلوب

وصف بنص حر. سلسلة فارغة عند عدم التعيين.

list_type
enum<string>
مطلوب

blocklist: يؤدي التطابق إلى رفض الجلسة أو المعاملة (قوائم النظام فقط، واحدة لكل نوع إدخال). allowlist: العناصر المتطابقة تكون موثوقة، على سبيل المثال تتخطى قائمة السماح للوجوه إجراء الوجه المكرر؛ ولا تتجاوز أبدًا تطابق قائمة الحظر. custom: تُستخدم في شروط قواعد سير العمل والمعاملات (value_type: "list").

الخيارات المتاحة:
blocklist,
allowlist,
custom
entry_type
enum<string>
مطلوب

ما تحتويه القائمة: face، أو document (رقم المستند)، أو phone، أو email، أو ip_address (عنوان IP أو نطاق CIDR)، أو device_fingerprint، أو wallet_address، أو bank_account، أو country (وفق معيار ISO 3166-1 alpha-3)، أو user أو business (الخاص بـ vendor_data لديك)، أو key (أي سلسلة نصية). وتحدد هذه القيمة كيفية التحقق من صحة قيم الإدخال ومطابقتها.

الخيارات المتاحة:
face,
document,
phone,
email,
ip_address,
device_fingerprint,
wallet_address,
bank_account,
country,
user,
business,
key
is_system
boolean
مطلوب

تكون القيمة true للقوائم التي توفرها Didit: قائمة حظر واحدة لكل نوع إدخال (face، وdocument، وphone، وemail، وip_address، وdevice_fingerprint، وwallet_address، وbank_account، وuser، وbusiness)، والقائمة المخصصة High Risk Countries، وقوائم السماح الخاصة بالنظام. لا يمكن إعادة تسمية قوائم النظام أو تعديلها أو حذفها؛ ولكن يمكنك إضافة مدخلاتها وحذفها.

entry_count
integer
مطلوب

عدد الإدخالات الموجودة حالياً في القائمة.

النطاق المطلوب: x >= 0
last_entry_added_at
string<date-time> | null
مطلوب

متى أُضيف أحدث مدخل حالي. وتكون null للقائمة الفارغة.

created_at
string<date-time>
مطلوب

متى تم إنشاء القائمة.

updated_at
string<date-time>
مطلوب

متى تم تحديث القائمة آخر مرة.

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