> ## 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: सभी ब्लॉकलिस्ट और allowlist

> Didit के साथ GET /v3/lists/ से सभी ब्लॉकलिस्ट, allowlist और कस्टम लिस्ट पाएँ। एंट्री प्रकार से फ़िल्टर करें। पे-पर-कॉल, कोई अनुबंध नहीं।



List Lists API प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`Retrieve every blocklist, allowlist, and custom list in my Didit application through the Management API.

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

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

Goal:
\- Get a paginated list of all lists for my application so I can find a specific list's uuid, filter by type, or render a picker.

Behavior:
\- Returns the application's active lists, newest first by default. Deleted lists never appear.
\- Includes the system lists Didit provisions (is_system: true): one blocklist per entry type, the "High Risk Countries" custom list, and any system allowlist.
\- Paginated with limit (default 50) and offset. Follow next until it is null.

Query parameters (all optional):
\- list_type: "blocklist" | "allowlist" | "custom".
\- entry_type: face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, country, user, business, key.
\- ordering: created_at or -created_at (default).
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

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

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: list id; use it as list_uuid in the list and entry calls.
\- results[].is_system: true for the lists Didit provisions. System lists cannot be renamed, edited or deleted, but you can add and remove their entries.
\- results[].entry_count, last_entry_added_at: computed over the list's current entries; useful for dashboards.

Failure modes:
\- 400: an unknown list_type or entry_type value, 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>



      
      

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

आपके एप्लिकेशन की हर सक्रिय सूची की पृष्ठांकित सूची प्राप्त करें। इसमें वे सिस्टम सूचियाँ शामिल हैं जो Didit प्रदान करता है (प्रत्येक प्रविष्टि प्रकार के लिए एक ब्लॉकलिस्ट, **High Risk Countries** सूची, और कोई भी सिस्टम अलाउलिस्ट), साथ ही वे अलाउलिस्ट और कस्टम सूचियाँ जो आपने बनाई हैं। `list_type` या `entry_type` से फ़िल्टर करें, और [सूची प्रविष्टियाँ](https://docs.didit.me/hi/management-api/lists/list-entries.md) से किसी सूची के मान पढ़ें।सत्यापन और लेन-देन स्क्रीनिंग के दौरान हर सूची प्रकार क्या करता है, यह जानने के लिए [सूचियाँ](https://docs.didit.me/hi/management-api/lists/overview.md) देखें।


## OpenAPI

````yaml hi/openapi-25.json GET /v3/lists/
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/:
    get:
      tags:
        - Lists
      summary: सूचियाँ सूचीबद्ध करें
      description: >-
        एप्लिकेशन की सूचियाँ लौटाता है, नवीनतम पहले: सिस्टम सूचियाँ जो Didit
        प्रदान करता है (प्रति प्रविष्टि प्रकार एक ब्लॉकलिस्ट, **High Risk
        Countries** कस्टम सूची, और कोई भी सिस्टम allowlist) और आपके द्वारा बनाई
        गई allowlists और कस्टम सूचियाँ। `list_type` और `entry_type` के साथ
        फ़िल्टर करें; हटाई गई सूचियाँ कभी दिखाई नहीं देती हैं। परिणाम `limit` और
        `offset` के साथ पेजिनेटेड होते हैं। एक स्कोप्ड API कुंजी के लिए
        `workflows: read` आवश्यक है। प्रत्येक सूची प्रकार क्या करता है, इसके लिए
        [सूचियाँ](https://docs.didit.me/hi/management-api/lists/overview) देखें।
      operationId: list_lists
      parameters:
        - name: list_type
          in: query
          required: false
          description: केवल इस प्रकार की सूचियाँ।
          schema:
            type: string
            enum:
              - blocklist
              - allowlist
              - custom
        - name: entry_type
          in: query
          required: false
          description: केवल इस प्रविष्टि प्रकार की सूचियाँ।
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
              - ip_address
              - device_fingerprint
              - wallet_address
              - bank_account
              - country
              - user
              - business
              - key
        - name: ordering
          in: query
          required: false
          description: >-
            सॉर्ट क्रम: `-created_at` (सबसे नए पहले, डिफ़ॉल्ट) या `created_at`
            (सबसे पुराने पहले)।
          schema:
            type: string
            enum:
              - '-created_at'
              - created_at
            default: '-created_at'
        - 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/ComplianceList'
              examples:
                Lists:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: 22222222-3333-4444-5555-666666666666
                        name: Trusted office IPs
                        description: Office egress ranges
                        list_type: allowlist
                        entry_type: ip_address
                        is_system: false
                        entry_count: 3
                        last_entry_added_at: '2026-10-02T08:15:27.501334Z'
                        created_at: '2026-09-30T13:20:45.889120Z'
                        updated_at: '2026-09-30T13:20:45.889120Z'
                      - uuid: 11111111-2222-3333-4444-555555555555
                        name: Face Blocklist
                        description: >-
                          Blocked biometric faces. When a face matching an entry
                          in this list is detected during liveness verification,
                          the session will be automatically declined.
                        list_type: blocklist
                        entry_type: face
                        is_system: true
                        entry_count: 12
                        last_entry_added_at: '2026-10-09T16:42:03.118204Z'
                        created_at: '2026-01-14T10:02:11.402917Z'
                        updated_at: '2026-01-14T10:02:11.402917Z'
        '400':
          description: एक क्वेरी पैरामीटर अमान्य है।
          content:
            application/json:
              examples:
                Unknown list type:
                  value:
                    list_type:
                      - '"denylist" is not a valid choice.'
                Unsupported ordering:
                  value:
                    ordering:
                      - '"name" 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/lists/?list_type=blocklist' \
              -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.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.lists.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\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().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->lists->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.lists.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.Lists.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    ComplianceList:
      type: object
      description: एक एप्लिकेशन की ब्लॉकलिस्ट, allowlist या कस्टम सूची।
      required:
        - uuid
        - name
        - description
        - list_type
        - entry_type
        - is_system
        - entry_count
        - last_entry_added_at
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            सूची पहचानकर्ता। इसे सूची और प्रविष्टि endpoint में `list_uuid` के
            रूप में, और `value_type: "list"` के साथ वर्कफ़्लो या लेन-देन नियम
            शर्त के मान के रूप में उपयोग करें।
        name:
          type: string
          maxLength: 255
          description: सूची का नाम, एप्लिकेशन की सूचियों के बीच अद्वितीय।
        description:
          type: string
          description: मुक्त-पाठ विवरण। सेट न होने पर खाली स्ट्रिंग।
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: एक मिलान सत्र या लेन-देन को अस्वीकार कर देता है (केवल
            सिस्टम सूचियां, प्रति प्रविष्टि प्रकार एक)। `allowlist`: मिलान करने
            वाले आइटम विश्वसनीय होते हैं, उदाहरण के लिए एक फ़ेस अनुमति सूची
            डुप्लिकेट-फ़ेस कार्रवाई को छोड़ देती है; कभी भी ब्लॉकलिस्ट मिलान को
            ओवरराइड नहीं करती। `custom`: वर्कफ़्लो और लेन-देन नियम शर्तों में
            उपयोग किया जाता है (`value_type: "list"`)।
        entry_type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
            - ip_address
            - device_fingerprint
            - wallet_address
            - bank_account
            - country
            - user
            - business
            - key
          description: >-
            सूची में क्या समाहित है: `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` (कोई भी स्ट्रिंग)। यह तय करता है कि प्रविष्टि मानों को कैसे
            मान्य और मिलान किया जाता है।
        is_system:
          type: boolean
          description: >-
            Didit द्वारा प्रदान की जाने वाली सूचियों के लिए `true`: प्रत्येक
            प्रविष्टि प्रकार (`face`, `document`, `phone`, `email`,
            `ip_address`, `device_fingerprint`, `wallet_address`,
            `bank_account`, `user`, `business`) के लिए एक ब्लॉकलिस्ट, **High
            Risk Countries** कस्टम सूची, और सिस्टम अनुमत सूचियाँ। सिस्टम सूचियों
            का नाम बदला, संपादित या हटाया नहीं जा सकता; आप उनकी प्रविष्टियाँ
            जोड़ और हटा सकते हैं।
        entry_count:
          type: integer
          minimum: 0
          description: वर्तमान में सूची में प्रविष्टियों की संख्या।
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: नवीनतम वर्तमान प्रविष्टि कब जोड़ी गई थी। खाली सूची के लिए `null`।
        created_at:
          type: string
          format: date-time
          description: सूची कब बनाई गई थी।
        updated_at:
          type: string
          format: date-time
          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.