> ## 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. # واجهة إدخالات القوائم: عناصر قائمة الحظر والسماح > GET /v3/lists/{list_uuid}/entries/: استرجاع إدخالات من قائمة الحظر أو السماح أو قائمة مخصصة في Didit مع تصفية البحث. الدفع لكل استدعاء. موجّه API لسرد الإدخالات نسخ الموجّه إلى الحافظة \

\`Retrieve paginated entries from a Didit list through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/entries/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Browse, search, or export the entries inside a specific list (blocklist, allowlist, or custom).

Path parameter:
\- list_uuid: the list UUID from GET /v3/lists/.

Query parameters (all optional):
\- search: case-insensitive text that value or display_label must contain.
\- reference_session_id: only the entries taken from this person verification session (for example, to see which of its faces are already in the face blocklist). Must be a session UUID.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Behavior:
\- Current entries only, newest first.
\- Image URLs in metadata (reference_image_url, front_image_url) are short-lived signed URLs, issued again on every call. A scoped key without media: read gets null in their place.

Example call:
curl -X GET "https://verification.didit.me/v3/lists/{list_uuid}/entries/?search=example.com" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: entry id; use it as entry_uuid in DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/.
\- results[].value: the listed value (phone number in E.164, email, document number, IP or CIDR range, wallet address, country code, vendor_data, or a face UUID on face lists). Matching is case-insensitive.
\- results[].display_label, comment: labels and notes.
\- results[].added_by: "api" (an API key), a console user's email or "console", "system" (entries Didit provisions), or "rule" (a transaction rule action).
\- results[].reference_session_id / reference_session_number / reference_session_type: set when the entry was taken from a verification session; reference_session_type is "kyc" or "kyb".
\- results[].reference_object_uuid + metadata.reference_type: the record the entry stands for. metadata.reference_type, when you set it, says whether reference_object_uuid is a "transaction", a "vendor_user" or a "vendor_business".
\- results[].metadata: may include document context (full_name, issuing_state, document_type, document_number), face image URLs, and, for faces from a document-capture selfie, face_image_source and reference_node_id.

Failure modes:
\- 400: reference_session_id is not a valid UUID, or limit/offset above 1000000.
\- 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: read.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "List not found." }).
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\
الصق في استرجع إدخالات قائمة واحدة، من الأحدث إلى الأقدم، مع بحث اختياري. يطابق `search` جزءاً من قيمة الإدخال أو تسميته دون مراعاة حالة الأحرف، ويحصر `reference_session_id` النتائج في الإدخالات المأخوذة من جلسة تحقق واحدة. في قائمة الوجوه، يحدد `metadata.face_image_source` أي وجه من وجوه الجلسة يمثله كل إدخال، وتكون القيمة `liveness` عند غياب الحقل.تتضمن إدخالات الوجوه والمستندات روابط صور في `metadata` تنتهي صلاحيتها بعد وقت قصير من الاستدعاء. استرجع الإدخالات مرة أخرى للحصول على روابط جديدة بدلاً من تخزينها. يتلقى مفتاح API الذي لا يملك **media: read** القيمة `null` لتلك الروابط. ## OpenAPI ````yaml ar/openapi-25.json GET /v3/lists/{list_uuid}/entries/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API التحقق من الهوية. قم بالمصادقة باستخدام الرأس x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/{list_uuid}/entries/: get: tags: - Lists summary: عرض مدخلات القائمة description: >- يعرض المدخلات الحالية لقائمة واحدة، بدءاً من الأحدث. يطابق `search` جزءاً من `value` أو `display_label` للمدخلة بصرف النظر عن حالة الأحرف، بينما يضيق `reference_session_id` النتائج لتقتصر على المدخلات المأخوذة من جلسة تحقق واحدة لشخص. عناوين URL للصور في `metadata` هي روابط URL موقعة ومؤقتة الصلاحية يُعاد إصدارها مع كل استدعاء؛ ويتلقى مفتاح API محدد النطاق بدون صلاحية `media: read` القيمة `null` بدلاً منها. يتطلب مفتاح API محدد النطاق صلاحية `workflows: read`. operationId: list_list_entries parameters: - name: list_uuid in: path required: true description: معرّف UUID للقائمة، كما تم إرجاعه بواسطة سرد القوائم أو إنشاء قائمة. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: search in: query required: false description: >- نص غير حساس لحالة الأحرف يجب أن يحتوي عليه `value` أو `display_label` الخاص بالمدخلة. schema: type: string - name: reference_session_id in: query required: false description: >- فقط الإدخالات المأخوذة من جلسة التحقق من الشخص هذه، على سبيل المثال لمعرفة أي من وجوهها مدرج بالفعل. schema: type: string format: uuid - name: limit in: query required: false description: >- حجم الصفحة. القيمة الافتراضية 50. القيمة الأعلى من 1000000 تُرجع `400`؛ والقيمة الصفرية أو السالبة أو غير الرقمية ترجع إلى 50. schema: type: integer default: 50 minimum: 1 maximum: 1000000 - name: offset in: query required: false description: >- فهرس يستند إلى الصفر للعنصر الأول المراد إرجاعه. يُفضل اتباع `next`. القيمة التي تزيد عن 1000000 تُرجع `400`؛ والقيمة السالبة أو غير الرقمية ترجع تلقائياً إلى 0. schema: type: integer maximum: 1000000 minimum: 0 default: 0 responses: '200': description: صفحة من المدخلات، الأحدث أولاً. content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer minimum: 0 description: العدد الإجمالي للإدخالات المطابقة للمرشحات. next: type: string format: uri nullable: true description: رابط URL مطلق للصفحة التالية، أو `null` في الصفحة الأخيرة. previous: type: string format: uri nullable: true description: رابط URL مطلق للصفحة السابقة، أو `null` في الصفحة الأولى. results: type: array items: $ref: '#/components/schemas/ComplianceListEntry' examples: Entries: value: count: 2 next: null previous: null results: - uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff value: X1234567 display_label: Jane Doe - X1234567 comment: '' added_by: api reference_session_id: 33333333-4444-5555-6666-777777777777 reference_session_number: 1042 reference_session_type: kyc reference_object_uuid: 66666666-7777-8888-9999-000000000000 metadata: full_name: Jane Doe issuing_state: ESP document_type: ID region: '' document_number: X1234567 created_at: '2026-10-12T10:06:12.774915Z' - uuid: eeeeeeee-ffff-0000-1111-222222222222 value: y7654321 display_label: '' comment: Reported by a partner added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: null metadata: null created_at: '2026-10-03T07:48:30.552810Z' '400': description: أحد معاملات الاستعلام غير صالح. content: application/json: examples: Invalid session id: value: reference_session_id: - Must be a valid UUID. Limit too large: value: - limit must not exceed 1000000. '401': description: >- انتهت صلاحية مفتاح API محدد النطاق. تُرجع حالات فشل المصادقة الأخرى الرمز `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- رأس `x-api-key` مفقود (المفتاح الخاطئ أو الملغى أو منتهي الصلاحية يحصل على `401`)، أو أن مفتاح API محدد النطاق يفتقر إلى `workflows: read` أو تم استخدامه من عنوان IP خارج قائمة السماح الخاصة به. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no read access to workflows. '404': description: >- لا توجد قائمة بهذا المعرّف UUID في التطبيق المرتبط بمفتاح API، أو قد تم حذفها. content: application/json: examples: Not found: value: detail: List not found. '429': description: >- تم تجاوز حد القراءة المشترك البالغ 600 طلب في الدقيقة لكل مفتاح API. التزم بالمدة المحددة في `Retry-After` قبل إعادة المحاولة. content: application/json: examples: Rate limited: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.lists.entries.list( "11111111-2222-3333-4444-555555555555", ): print(item) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.lists.entries.list("11111111-2222-3333-4444-555555555555")) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: >- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.lists().entries().list("11111111-2222-3333-4444-555555555555")) { System.out.println(item); } - lang: php label: PHP source: >- lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.lists.entries.list("11111111-2222-3333-4444-555555555555").auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Lists.Entries.ListAsync("11111111-2222-3333-4444-555555555555")) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: ComplianceListEntry: type: object description: قيمة واحدة في قائمة. required: - uuid - value - display_label - comment - added_by - reference_session_id - reference_session_number - reference_session_type - reference_object_uuid - metadata - created_at properties: uuid: type: string format: uuid description: معرّف المُدخل. استخدمه كـ `entry_uuid` في حذف مُدخل من قائمة. value: type: string description: >- القيمة المدرجة: رقم هاتف بصيغة E.164، أو عنوان بريد إلكتروني، أو رقم مستند، أو عنوان IP أو نطاق CIDR، أو بصمة جهاز، أو عنوان محفظة، أو حساب مصرفي، أو رمز دولة وفق معيار ISO 3166-1 alpha-3، أو `vendor_data`، أو أي سلسلة نصية في قائمة `key`، أو UUID للوجه المخزن في قائمة الوجوه. تُخزن القيم التي ترسلها بأحرف صغيرة، باستثناء أرقام الهواتف ورموز الدول. مطابقة النصوص غير حساسة لحالة الأحرف. display_label: type: string nullable: true maxLength: 512 description: >- تسمية سهلة القراءة. تملؤها Didit للإدخالات المأخوذة من جلسة (على سبيل المثال اسم حامل المستند ورقمه) إذا لم ترسل أياً منها. comment: type: string description: ملاحظة بنص حر. سلسلة فارغة عند عدم التعيين. added_by: type: string nullable: true description: >- من أضاف الإدخال: `api` (مفتاح API)، أو عنوان البريد الإلكتروني لمستخدم لوحة التحكم أو `console`، أو `system` أو `migration` (إدخالات أنشأتها Didit)، أو `rule` (إجراء قاعدة معاملات أو قاعدة مراقبة). reference_session_id: type: string format: uuid nullable: true description: >- جلسة التحقق التي تم أخذ الإدخال منها. `null` عندما تتم إضافة الإدخال حسب القيمة. reference_session_number: type: integer nullable: true description: رقم لتلك الجلسة بنطاق التطبيق، كما يظهر في وحدة التحكم. reference_session_type: type: string nullable: true enum: - kyc - kyb - null description: >- `kyc` لجلسة التحقق من شخص، و`kyb` لجلسة التحقق من شركة، و`null` عندما لا توجد جلسة. reference_object_uuid: type: string format: uuid nullable: true description: >- السجل الذي يمثله الإدخال: سجل الوجه، أو المستند، أو الهاتف، أو البريد الإلكتروني المقروء من الجلسة، أو الوجه الذي تم إنشاؤه عبر تحميل وجه إلى قائمة، أو UUID الذي أرسلته (على سبيل المثال UUID لمعاملة أو `didit_internal_id` الخاص بالمستخدم). metadata: type: object nullable: true additionalProperties: true description: >- سياق إضافي. يحتوي على المفاتيح التي تعينها Didit (المدرجة هنا) مدمجة مع أي `metadata` أرسلتها عند إنشاء الإدخال، وتُعاد كما تم تخزينها. ويكون `null` عند عدم وجود أي منها. properties: reference_image_url: type: string description: >- مدخلات الوجه: عنوان URL قصير الأجل وموقّع، يُصدَر مجددًا مع كل استدعاء؛ ويكون `null` لمفتاح API ذي نطاق محدد بدون `media: read`. غير موجود عندما لا تنتمي أي صورة إلى المدخل. front_image_url: type: string description: >- مدخلات المستند التي تتضمن صورة أمامية للمستند: رابط URL موقّع قصير الأجل، يُصدر مجدداً عند كل استدعاء؛ `null` لمفتاح API ذي نطاق محدد دون صلاحية `media: read`. full_name: type: string description: 'مدخلات المستند المأخوذة من الجلسة: الاسم الكامل لحامل المستند.' issuing_state: type: string description: >- مدخلات المستند المأخوذة من الجلسة: دولة الإصدار بتنسيق ISO 3166-1 alpha-3. document_type: type: string description: >- مدخلات المستند المأخوذة من الجلسة: رمز نوع المستند، على سبيل المثال `P` أو `ID` أو `DL`. region: type: string description: >- مدخلات المستند المأخوذة من الجلسة: الولاية أو المقاطعة المصدرة لمستند صادر إقليمياً، وتكون فارغة عندما لا تنطبق. لا يتم ضبطها بواسطة إضافة عناصر الجلسة إلى قائمة الحظر. document_number: type: string description: 'مدخلات المستند المأخوذة من الجلسة: رقم المستند.' face_image_source: type: string enum: - front_image_camera_front - back_image_camera_front description: >- مدخلات الوجه المأخوذة من صورة سيلفي ملتقطة مع المستند: أي صورة سيلفي. غير موجودة لوجوه كشف الحيوية. reference_node_id: type: string nullable: true description: >- مدخلات الوجه المأخوذة من صورة سيلفي ملتقطة مع المستند: عقدة التحقق من الهوية التي وردت منها صورة السيلفي. fingerprint_tier: type: string nullable: true enum: - persistent_id - composite_hash - legacy_fp - unknown - null description: >- مدخلات بصمة الجهاز المأخوذة من جلسة: كيفية استخلاص البصمة. يحدد `persistent_id` جهازاً واحداً؛ بينما يمكن مشاركة `composite_hash` و`legacy_fp` بين أجهزة من نفس الطراز. sandbox: type: boolean description: >- تكون القيمة `true` لمدخل وجه تم رفعه في تطبيق في البيئة التجريبية؛ ولا يطابق هذا المدخل أي شيء. reference_type: type: string enum: - transaction - vendor_user - vendor_business description: >- مُعيَّن بواسطتك: ما يشير إليه `reference_object_uuid`، لتربط لوحة التحكم به مجدداً. reference_id: type: string description: 'مُعيَّن بواسطتك: معرّف السجل المصدر.' created_at: type: string format: date-time description: وقت إضافة المُدخل. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.