> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# واجهة برمجة قوائم الحظر والسماح

> أدِر قوائم الحظر والسماح والقوائم المخصصة في Didit للتحقق من الهوية (KYC) ومكافحة الاحتيال وفحص المعاملات. بنية تحتية متكاملة للهوية، والدفع لكل استدعاء.



موجّه Lists API
        نسخ الموجّه إلى الحافظة



      
      

\<pre>

\`Manage Didit blocklists, allowlists, and custom lists through the Management API.

Base path:
https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key on every call.

Concepts:
\- Blocklist — system-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening. Cannot be deleted or renamed.
\- Allowlist: created by you, or by Didit as a system allowlist that cannot be renamed or deleted. Used in workflow conditions and to suppress duplicate/reuse actions for trusted matching items.
\- Custom — user-created. Flexible lists for workflow branching, monitoring rules, or manual review.

Supported entry_type values:
face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.

Endpoints I should know:
\- GET /v3/lists/ — list all lists (filter by list_type, entry_type).
\- POST /v3/lists/ — create allowlist or custom list (cannot create blocklists).
\- GET /v3/lists/{list_uuid}/ — get one list.
\- PATCH /v3/lists/{list_uuid}/ — rename or update description (system lists immutable).
\- DELETE /v3/lists/{list_uuid}/ — delete allowlist/custom only. Returns 204.
\- GET /v3/lists/{list_uuid}/entries/ — paginated entries; supports search query.
\- POST /v3/lists/{list_uuid}/entries/ — add an entry by value, by reference_session_id, or by reference_object_uuid + metadata.reference_type ("transaction" | "vendor_user" | "vendor_business").
\- POST /v3/lists/{list_uuid}/entries/face-upload/: upload a base64 face image to a face blocklist or face allowlist; Didit extracts the biometric.
\- DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ — remove an entry. For system blocklists this auto-unblocks the underlying entity.

Value validation (Create entry):
\- email — valid email address.
\- phone — valid international phone number (auto-normalized to E.164).
\- ip_address — IP or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country — ISO 3166-1 alpha-3 (alpha-2 is accepted and converted).
\- Other types — any non-empty string. Values are case-insensitive and normalized on storage.

Traceability:
\- Pass reference_session_id when blocklisting from a verification session: Didit auto-extracts the right value (face/document/phone/email/IP/device), marks the underlying model as blocklisted, and links the entry back to the session. Didit reads the session's most recent record of that type; to list a value from an earlier record, add it by value without reference_session_id.
\- Pass reference_object_uuid plus metadata.reference_type ("transaction" | "vendor_user" | "vendor_business") when blocklisting from a transaction or vendor user/business so the console can link back to the source.

Common failure modes:
\- 400: value fails the entry_type validator or is already in the list, list_type is wrong for the operation (e.g. POST face-upload on a non-face list), reference_session_id has no data of the requested type, a system list is modified or deleted, or a list name is already used in this application (on create or rename).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows access.
\- 404: list or entry not found in this application (a list of another application also returns 404).

Side effects:
\- Adding to a system blocklist immediately blocks future matches at verification/screening time.
\- Deleting an entry from a system blocklist unblocks the matching entity.
\- Lists are referenced by workflow status_rules (value_type: "list") for runtime list checks.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`

\</pre>



      
      

الصق في

تتيح لك Lists API إدارة قوائم مصنّفة حسب النوع لتطبيقك. تُنشأ قوائم الحظر النظامية تلقائياً وتُفحص أثناء التحقق وفحص المعاملات. يمكنك أيضاً إنشاء قوائم السماح والقوائم المخصصة لاستخدامها في شروط سير العمل.## المفاهيم الأساسية| النوع | الوصف |
| - | - |
| **قائمة الحظر** | تُنشأ من النظام، قائمة واحدة لكل نوع مدخل. تؤدي العناصر الموجودة في قائمة الحظر إلى الرفض التلقائي أثناء التحقق أو فحص المعاملات. |
| **قائمة السماح** | يُنشئها المستخدم. تُستخدم في شروط سير العمل، ولكبت إجراءات التكرار أو إعادة الاستخدام للعناصر المطابقة الموثوقة. |
| **مخصص** | يُنشئه المستخدم. قوائم مرنة لتفريع سير العمل، أو قواعد المراقبة، أو المراجعة اليدوية. |## أنواع المدخلات| نوع المدخل | يُفحص أثناء | عند التطابق |
| - | - | - |
| `face` | كشف الحيوية | رفض الجلسة |
| `document` | التحقق من الهوية (OCR) | رفض الجلسة |
| `phone` | التحقق من رقم الهاتف | رفض الجلسة |
| `email` | التحقق من البريد الإلكتروني | رفض الجلسة |
| `ip_address` | تحليل الجهاز وعنوان IP (يدعم نطاقات CIDR) | رفض الجلسة |
| `device_fingerprint` | تحليل الجهاز وعنوان IP | رفض الجلسة |
| `wallet_address` | فحص المعاملات | رفض المعاملة |
| `bank_account` | فحص المعاملات | رفض المعاملة |
| `user` | فحص المعاملات | حظر المستخدم |
| `business` | فحص المعاملات | حظر الشركة |
| `country` | شروط سير العمل | قابل للتهيئة |
| `key` | الاستخدام المخصص | قابل للتهيئة |## قوائم السماحلا تتجاوز قوائم السماح قوائم الحظر ولا فحوصات الأصالة. فهي تكبت فقط إجراءات التكرار أو إعادة الاستخدام لنفس نوع المدخل. على سبيل المثال، يمكن لوجه موجود في قائمة سماح الوجوه أن يتجاوز الإجراء `DUPLICATED_FACE`، ويمكن لعنوان IP موجود في قائمة سماح عناوين IP أن يتجاوز الإجراء `DUPLICATED_IP_ADDRESS`، ويمكن لبصمة جهاز موجودة في قائمة سماح الأجهزة أن تتجاوز الإجراء `DUPLICATED_DEVICE_FINGERPRINT`. ومع ذلك، تسجّل Didit تحذيراً معلوماتياً من قائمة السماح حتى تتمكن من تدقيق سبب عدم تشغيل إجراء التكرار.## قوائم الحظر النظاميةيحصل كل تطبيق تلقائياً على 10 قوائم حظر نظامية (واحدة لكل نوع مدخل مدعوم) وعلى قائمة نظامية باسم **High Risk Countries**. لا يمكن حذف هذه القوائم أو إعادة تسميتها. يمكنك إضافة مدخلات إليها عبر واجهة البرمجة أو من وحدة التحكم.## التتبعيمكن ربط كل مدخل في قائمة الحظر بالكيان المصدر له، حتى تنتقل من القائمة إلى السجل الأصلي:- **من جلسة**: مرّر `reference_session_id` عند [إنشاء مدخل](https://docs.didit.me/ar/management-api/lists/create-entry.md). تستخرج Didit القيمة تلقائياً (الوجه أو المستند أو الهاتف أو البريد الإلكتروني أو عنوان IP أو الجهاز)، وتعلّم النموذج الأساسي بأنه محظور، وتربط المدخل بالجلسة. تقرأ Didit أحدث سجل من ذلك النوع في الجلسة. لإدراج قيمة من سجل أقدم، أضفها بالحقل `value` دون `reference_session_id`.
- **من معاملة أو مستخدم أو شركة**: مرّر `reference_object_uuid` مع المعرّف الفريد العالمي (UUID) للكيان، وأدرج `metadata.reference_type` (`"transaction"` أو `"vendor_user"` أو `"vendor_business"`) حتى تتمكن وحدة التحكم من الربط بالسجل الأصلي.## نقاط النهاية> [card] [عرض جميع القوائم](https://docs.didit.me/ar/management-api/lists/list.md)
>
> استرجاع جميع القوائم الخاصة بالتطبيق.> [card] [عرض المدخلات](https://docs.didit.me/ar/management-api/lists/list-entries.md)
>
> استرجاع المدخلات الموجودة في قائمة.> [card] [إنشاء مُدخل](https://docs.didit.me/ar/management-api/lists/create-entry.md)
>
> إضافة قيمة إلى قائمة حظر، بالقيمة أو بمرجع الجلسة أو بمرجع المعاملة.> [card] [حذف مُدخل](https://docs.didit.me/ar/management-api/lists/delete-entry.md)
>
> إزالة مُدخل وإلغاء حظر الكيان الأساسي.> [card] [رفع وجه](https://docs.didit.me/ar/management-api/lists/upload-face.md)
>
> رفع صورة وجه مباشرةً إلى قائمة حظر الوجوه.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.