> ## 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.

# ब्लॉकलिस्ट और Allowlist आइटम: List Entries API

> GET /v3/lists/{list_uuid}/entries/: खोज फ़िल्टर के साथ Didit की ब्लॉकलिस्ट, allowlist या कस्टम सूची की पेजिनेटेड प्रविष्टियाँ प्राप्त करें। प्रति कॉल भुगतान।



सूची प्रविष्टियाँ API प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

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

\</pre>



      
      

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

किसी एक सूची की प्रविष्टियाँ सबसे नई से सबसे पुरानी के क्रम में लौटाएँ, वैकल्पिक खोज के साथ। `search` प्रविष्टि के मान या लेबल के किसी भाग से मेल खाता है, और इसमें अक्षरों के बड़े-छोटे होने का ध्यान नहीं रखा जाता। `reference_session_id` परिणामों को उन प्रविष्टियों तक सीमित करता है जो किसी एक सत्यापन सत्र से ली गई हैं। चेहरे की सूची में, `metadata.face_image_source` बताता है कि प्रत्येक प्रविष्टि सत्र के किस चेहरे से है (अनुपस्थित होने पर `liveness`)।चेहरे और दस्तावेज़ प्रविष्टियों के `metadata` में इमेज URL होते हैं, जो कॉल के थोड़ी देर बाद समाप्त हो जाते हैं। इन URL को संग्रहीत करने के बजाय नए URL पाने के लिए प्रविष्टियाँ फिर से लाएँ। **media: read** के बिना API कुंजी को इन URL के लिए `null` मिलता है।


## OpenAPI

````yaml hi/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` परिणामों को एक व्यक्ति सत्यापन
        सत्र से ली गई प्रविष्टियों तक सीमित करता है। `metadata` में इमेज URL
        अल्पकालिक हस्ताक्षरित URL होते हैं जो प्रत्येक कॉल पर पुनः जारी किए जाते
        हैं; बिना `media: read` वाली एक स्कोप्ड API कुंजी को उनके स्थान पर
        `null` प्राप्त होता है। एक स्कोप्ड API कुंजी के लिए `workflows: read`
        आवश्यक है।
      operationId: list_list_entries
      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
        - 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: >-
            API कुंजी के एप्लिकेशन में इस UUID वाली कोई सूची मौजूद नहीं है, या
            इसे हटा दिया गया था।
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '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/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: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach
            ($didit->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, प्रत्येक कॉल
                पर फिर से जारी किया जाता है; बिना `media: read` वाली स्कोप्ड API
                कुंजी के लिए `null`। प्रविष्टि से संबंधित कोई छवि न होने पर
                अनुपस्थित।
            front_image_url:
              type: string
              description: >-
                दस्तावेज़ प्रविष्टियां जिनमें दस्तावेज़ की सामने की छवि शामिल
                है: अल्पकालिक हस्ताक्षरित URL, प्रत्येक कॉल पर पुनः जारी किया
                जाता है; `media: read` के बिना स्कोप्ड API कुंजी के लिए `null`।
            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: >-
                सत्र से ली गई दस्तावेज़ प्रविष्टियां: क्षेत्रीय रूप से जारी
                दस्तावेज़ का जारीकर्ता राज्य या प्रांत, लागू न होने पर खाली। Add
                session items to the blocklist द्वारा सेट नहीं किया गया।
            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 कुंजी, 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.