> ## 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. # عرض عناصر قائمة الحظر API > GET /v3/blocklist/: عرض الوجوه والمستندات وأرقام الهواتف والبريد الإلكتروني المدرجة في قائمة الحظر من جلسات Didit، الأحدث أولاً، في تغذية واحدة. موجّه واجهة API لعرض العناصر المحظورة نسخ الموجّه إلى الحافظة \

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

Endpoint:
GET https://verification.didit.me/v3/blocklist/

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

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/blocklist/?item_type=document" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, 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.
\- 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.`

\
الصق في اعرض الوجوه ووثائق الهوية وأرقام الهواتف وعناوين البريد الإلكتروني الموجودة في جلسات التحقق الخاصة بك والمدرجة حاليًا في قائمة الحظر، مرتبة من الأحدث إلى الأقدم. يشير كل عنصر إلى الجلسة التي جاء منها، حتى تتمكن من فتحها في وحدة التحكم أو جلب قرارها.تعرض هذه الخلاصة ما أُضيف إلى قائمة الحظر **من جلسة**: باستخدام [إضافة إلى قائمة الحظر](https://docs.didit.me/ar/management-api/blocklist/add.md) من وحدة التحكم، أو عبر [إدخال في القائمة](https://docs.didit.me/ar/management-api/lists/create-entry.md) أُنشئ من `reference_session_id`. أما القيم المُدخلة يدويًا في قائمة، و[الوجوه المرفوعة](https://docs.didit.me/ar/management-api/lists/upload-face.md)، والوجوه المأخوذة من صورة السيلفي الملتقطة مع المستند، وأنواع الإدخال الأخرى (عنوان IP، وبصمة الجهاز، والمحفظة، والحساب المصرفي، والمستخدم، والشركة)، فتوجد فقط في قوائم الحظر النظامية، ويمكنك قراءتها عبر [سرد الإدخالات](https://docs.didit.me/ar/management-api/lists/list-entries.md).راجع [حظر المستخدمين](https://docs.didit.me/ar/console/blocklist-users.md) لمعرفة كيفية عمل الحظر في وحدة التحكم. ## OpenAPI ````yaml ar/openapi-25.json GET /v3/blocklist/ 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/blocklist/: get: tags: - Blocklist summary: سرد العناصر المدرجة في قائمة الحظر description: >- يعرض موجزاً مقسماً إلى صفحات للوجوه، ومستندات الهوية، وأرقام الهواتف، وعناوين البريد الإلكتروني الخاصة بجلسات التحقق في التطبيق والمدرجة حالياً في قائمة الحظر، بدءاً من الأحدث بحسب `blocklisted_at`؛ يمكنك التصفية باستخدام `item_type`. لا يتم تضمين عناصر الجلسات المحذوفة. يغطي الموجز السجلات المدرجة في قائمة الحظر من جلسة (باستخدام [إضافة عناصر الجلسة إلى قائمة الحظر](https://docs.didit.me/ar/management-api/blocklist/add)، أو من لوحة التحكم، أو عبر مدخلة قائمة تم إنشاؤها من جلسة)؛ أما القيم المضافة يدوياً إلى قائمة، والوجوه المرفوعة، والوجوه المأخوذة من صورة سيلفي لالتقاط المستند وأنواع المدخلات الأخرى فتتم قراءتها عبر [عرض مدخلات القائمة](https://docs.didit.me/ar/management-api/lists/list-entries). يُعد كل من `face_image` و`front_image` روابط URL موقعة ومؤقتة الصلاحية، ويتلقى مفتاح API محدد النطاق بدون صلاحية `media: read` القيمة `null`. يتطلب مفتاح API محدد النطاق صلاحية `workflows: read`. operationId: list_blocklist_items parameters: - name: item_type in: query required: false description: العناصر من هذا النوع فقط. عند حذفه، يتم إرجاع كل نوع. schema: type: string enum: - face - document - phone - email - 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/BlocklistedItem' examples: Mixed feed: value: count: 2 next: null previous: null results: - type: document session_id: 33333333-4444-5555-6666-777777777777 session_number: 1042 blocklisted_at: '2026-10-12T10:06:12.701553Z' face_image: null document_type: ID document_number: X1234567 front_image: >- https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47 phone_number: null country_code: null email: null - type: phone session_id: 77777777-8888-9999-0000-111111111111 session_number: 1017 blocklisted_at: '2026-10-08T15:31:09.400127Z' face_image: null document_type: null document_number: null front_image: null phone_number: '+14155552671' country_code: US email: null '400': description: أحد معاملات الاستعلام غير صالح. content: application/json: examples: Unknown item type: value: item_type: - '"wallet" is not a valid choice.' 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. '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/blocklist/?item_type=document' \ -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.blocklist.list(): 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.blocklist.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\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.blocklist().list()) { System.out.println(item); } - lang: php label: PHP source: |- blocklist->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.blocklist.list.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.Blocklist.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: BlocklistedItem: type: object description: >- وجه، أو مستند هوية، أو رقم هاتف، أو عنوان بريد إلكتروني مدرج في قائمة الحظر من جلسة تحقق واحدة. وتكون الحقول التي لا تنطبق على `type` الخاص بالعنصر بقيمة `null`. required: - type - session_id - session_number - blocklisted_at - face_image - document_type - document_number - front_image - phone_number - country_code - email properties: type: type: string enum: - face - document - phone - email description: ما تم إدراجه في قائمة الحظر. session_id: type: string format: uuid description: جلسة التحقق التي ينتمي إليها العنصر. session_number: type: integer nullable: true description: رقم لتلك الجلسة بنطاق التطبيق، كما يظهر في وحدة التحكم. blocklisted_at: type: string format: date-time description: متى أُضيف العنصر إلى قائمة الحظر آخر مرة. face_image: type: string nullable: true description: >- عناصر الوجه: عنوان URL موقّع قصير الأجل، يُصدَر مجددًا مع كل استدعاء؛ ويكون `null` لمفتاح API ذي نطاق محدد بدون `media: read`. ويكون أيضًا `null` عند عدم تخزين أي صورة مرجعية. document_type: type: string nullable: true description: >- عناصر المستند: رمز نوع المستند، على سبيل المثال `P` (جواز سفر)، أو `ID` (بطاقة هوية وطنية)، أو `DL` (رخصة قيادة)، أو `RP` (تصريح إقامة). document_number: type: string nullable: true description: >- عناصر المستند: رقم المستند، أو الرقم الشخصي عندما لا يحتوي المستند على رقم. front_image: type: string nullable: true description: >- عناصر المستند: الصورة الأمامية للمستند، رابط URL موقّع قصير الأجل، يُصدر مجدداً عند كل استدعاء؛ `null` لمفتاح API ذي نطاق محدد دون صلاحية `media: read`. phone_number: type: string nullable: true description: 'عناصر الهاتف: رقم الهاتف بتنسيق E.164.' country_code: type: string nullable: true description: 'عناصر الهاتف: دولة الرقم وفقاً للمعيار ISO 3166-1 alpha-2.' email: type: string nullable: true 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.