> ## 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 प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`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.`

\</pre>



      
      

यहाँ पेस्ट करें

आपके सत्यापन सत्रों के उन चेहरों, पहचान दस्तावेज़ों, फ़ोन नंबरों और ईमेल पतों की सूची दें जो फ़िलहाल ब्लॉकलिस्ट में हैं, सबसे नए पहले। हर आइटम उस सत्र की ओर इशारा करता है जिससे वह आया, ताकि आप उसे कंसोल में खोल सकें या उसका निर्णय प्राप्त कर सकें।यह फ़ीड उन चीज़ों को दिखाता है जो **एक सत्र से** ब्लॉकलिस्ट में डाली गईं: [ब्लॉकलिस्ट में जोड़ें](https://docs.didit.me/hi/management-api/blocklist/add.md) से, कंसोल से, या `reference_session_id` से बनाई गई [सूची प्रविष्टि](https://docs.didit.me/hi/management-api/lists/create-entry.md) से। सूची में टाइप किए गए मान, [अपलोड किए गए चेहरे](https://docs.didit.me/hi/management-api/lists/upload-face.md), दस्तावेज़ कैप्चर सेल्फ़ी से लिए गए चेहरे, और अन्य प्रविष्टि प्रकार (पता, डिवाइस फ़िंगरप्रिंट, वॉलेट, बैंक खाता, उपयोगकर्ता, व्यवसाय) केवल सिस्टम ब्लॉकलिस्ट में रहते हैं: इन्हें [सूची प्रविष्टियाँ](https://docs.didit.me/hi/management-api/lists/list-entries.md) से पढ़ें।कंसोल में ब्लॉकलिस्ट कैसे काम करती है, इसके लिए [उपयोगकर्ताओं को ब्लॉकलिस्ट में डालना](https://docs.didit.me/hi/console/blocklist-users.md) देखें।


## OpenAPI

````yaml hi/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/hi/management-api/blocklist/add) के साथ,
        कंसोल से, या किसी सत्र से बनाई गई सूची प्रविष्टि द्वारा); सूची में
        मैन्युअल रूप से जोड़े गए मान, अपलोड किए गए चेहरे, दस्तावेज़-कैप्चर
        सेल्फ़ी से प्राप्त चेहरे और अन्य प्रविष्टि प्रकारों को [सूची
        प्रविष्टियों की सूची
        देखें](https://docs.didit.me/hi/management-api/lists/list-entries) के
        साथ पढ़ा जाता है। `face_image` और `front_image` अल्पकालिक हस्ताक्षरित
        URL हैं, और `media: read` के बिना स्कोप्ड API कुंजी को `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: >-
            प्रति API कुंजी प्रति मिनट 600 अनुरोधों की साझा पढ़ने की सीमा पार हो
            गई। पुनः प्रयास करने से पहले `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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->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, प्रत्येक कॉल पर फिर से
            जारी किया जाता है; बिना `media: read` वाली स्कोप्ड API कुंजी के लिए
            `null`। कोई संदर्भ छवि संग्रहीत न होने पर भी `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, प्रत्येक कॉल पर पुनः जारी किया जाता है; `media: read` के बिना
            स्कोप्ड API कुंजी के लिए `null`।
        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 कुंजी, Business Console में Developers -> API keys
        से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
        किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
        स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
        सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
        समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
        कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
        सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
        के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
        छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
        के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
        देखें https://docs.didit.me/console/api-keys।

````

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