> ## 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/lists/{list_uuid}/: Didit की ब्लॉकलिस्ट, एलाउलिस्ट या कस्टम सूची का विवरण, प्रविष्टियों की संख्या और मेटाडेटा सहित प्राप्त करें।



सूची प्राप्त करने के लिए API प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`Fetch a single Didit list's metadata through the Management API.

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

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

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

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

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 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": "No List matches the given query." }).
\- 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>



      
      

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

किसी एक सूची का विवरण प्राप्त करें, जिसमें उसकी प्रविष्टियों की संख्या और सबसे नई प्रविष्टि कब जोड़ी गई थी, यह भी शामिल है। किसी दूसरे एप्लिकेशन की सूची, या हटाई गई सूची के लिए `404` लौटाया जाता है।सूची के मान पढ़ने के लिए [सूची प्रविष्टियाँ](https://docs.didit.me/hi/management-api/lists/list-entries.md) का उपयोग करें।


## OpenAPI

````yaml hi/openapi-25.json GET /v3/lists/{list_uuid}/
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}/:
    get:
      tags:
        - Lists
      summary: एक सूची प्राप्त करें
      description: >-
        एप्लिकेशन की एक सूची, उसकी प्रविष्टि गणना और उसकी नवीनतम प्रविष्टि कब
        जोड़ी गई थी, इसके साथ लौटाता है। किसी अन्य एप्लिकेशन की सूची, या जिसे
        हटा दिया गया था, `404` लौटाती है। यह केवल सूची लौटाता है: इसके मानों को
        [सूची प्रविष्टियाँ सूचीबद्ध
        करें](https://docs.didit.me/hi/management-api/lists/list-entries) से
        पढ़ें। एक स्कोप्ड API कुंजी के लिए `workflows: read` आवश्यक है।
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            सूची का UUID, जैसा कि List lists या Create a list द्वारा लौटाया गया
            है।
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: सूची।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceList'
              examples:
                System face blocklist:
                  value:
                    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'
        '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: >-
            API कुंजी के एप्लिकेशन में इस UUID वाली कोई सूची मौजूद नहीं है, या
            इसे हटा दिया गया था।
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '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/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().retrieve("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
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.