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

# ब्लॉकलिस्ट और अलाउलिस्ट: Lists API

> Didit की ब्लॉकलिस्ट, अलाउलिस्ट और कस्टम सूचियाँ KYC, फ़्रॉड और लेन-देन स्क्रीनिंग के लिए प्रबंधित करें। ऑल-इन-वन पहचान इंफ्रा, प्रति कॉल भुगतान।



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



      
      

\<pre>

\`Manage Didit blocklists, allowlists, and custom lists through the Management API.

Base path:
https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key on every call.

Concepts:
\- Blocklist — system-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening. Cannot be deleted or renamed.
\- Allowlist: created by you, or by Didit as a system allowlist that cannot be renamed or deleted. Used in workflow conditions and to suppress duplicate/reuse actions for trusted matching items.
\- Custom — user-created. Flexible lists for workflow branching, monitoring rules, or manual review.

Supported entry_type values:
face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.

Endpoints I should know:
\- GET /v3/lists/ — list all lists (filter by list_type, entry_type).
\- POST /v3/lists/ — create allowlist or custom list (cannot create blocklists).
\- GET /v3/lists/{list_uuid}/ — get one list.
\- PATCH /v3/lists/{list_uuid}/ — rename or update description (system lists immutable).
\- DELETE /v3/lists/{list_uuid}/ — delete allowlist/custom only. Returns 204.
\- GET /v3/lists/{list_uuid}/entries/ — paginated entries; supports search query.
\- POST /v3/lists/{list_uuid}/entries/ — add an entry by value, by reference_session_id, or by reference_object_uuid + metadata.reference_type ("transaction" | "vendor_user" | "vendor_business").
\- POST /v3/lists/{list_uuid}/entries/face-upload/: upload a base64 face image to a face blocklist or face allowlist; Didit extracts the biometric.
\- DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ — remove an entry. For system blocklists this auto-unblocks the underlying entity.

Value validation (Create entry):
\- email — valid email address.
\- phone — valid international phone number (auto-normalized to E.164).
\- ip_address — IP or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country — ISO 3166-1 alpha-3 (alpha-2 is accepted and converted).
\- Other types — any non-empty string. Values are case-insensitive and normalized on storage.

Traceability:
\- Pass reference_session_id when blocklisting from a verification session: Didit auto-extracts the right value (face/document/phone/email/IP/device), marks the underlying model as blocklisted, and links the entry back to the session. Didit reads the session's most recent record of that type; to list a value from an earlier record, add it by value without reference_session_id.
\- Pass reference_object_uuid plus metadata.reference_type ("transaction" | "vendor_user" | "vendor_business") when blocklisting from a transaction or vendor user/business so the console can link back to the source.

Common failure modes:
\- 400: value fails the entry_type validator or is already in the list, list_type is wrong for the operation (e.g. POST face-upload on a non-face list), reference_session_id has no data of the requested type, a system list is modified or deleted, or a list name is already used in this application (on create or rename).
\- 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 access.
\- 404: list or entry not found in this application (a list of another application also returns 404).

Side effects:
\- Adding to a system blocklist immediately blocks future matches at verification/screening time.
\- Deleting an entry from a system blocklist unblocks the matching entity.
\- Lists are referenced by workflow status_rules (value_type: "list") for runtime list checks.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`

\</pre>



      
      

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

Lists API आपको अपने एप्लिकेशन के लिए टाइप्ड सूचियाँ प्रबंधित करने देता है। सिस्टम ब्लॉकलिस्ट अपने-आप बनती हैं और सत्यापन तथा लेन-देन स्क्रीनिंग के दौरान जाँची जाती हैं। आप वर्कफ़्लो शर्तों के लिए अनुमति सूचियाँ और कस्टम सूचियाँ भी बना सकते हैं।## अवधारणाएँ| प्रकार | विवरण |
| - | - |
| **ब्लॉकलिस्ट** | सिस्टम द्वारा बनाई जाती है, हर एंट्री प्रकार के लिए एक। ब्लॉकलिस्ट में मौजूद आइटम सत्यापन या लेन-देन स्क्रीनिंग के दौरान स्वचालित रूप से अस्वीकृत कर दिए जाते हैं। |
| **अनुमति सूची** | उपयोगकर्ता द्वारा बनाई जाती है। वर्कफ़्लो शर्तों में इस्तेमाल होती है और भरोसेमंद रूप से मिलान होने वाली आइटमों के लिए डुप्लीकेट/पुनः उपयोग कार्रवाइयों को रोकती है। |
| **कस्टम** | उपयोगकर्ता द्वारा बनाई जाती है। वर्कफ़्लो ब्रांचिंग, मॉनिटरिंग नियमों या मैन्युअल समीक्षा के लिए लचीली सूचियाँ। |## एंट्री प्रकार| एंट्री प्रकार | किसके दौरान जाँचा जाता है | मिलान होने पर |
| - | - | - |
| `face` | लाइवनेस सत्यापन | सत्र अस्वीकृत किया गया |
| `document` | पहचान सत्यापन (OCR) | सत्र अस्वीकृत किया गया |
| `phone` | फ़ोन सत्यापन | सत्र अस्वीकृत किया गया |
| `email` | ईमेल सत्यापन | सत्र अस्वीकृत किया गया |
| `ip_address` | डिवाइस और IP विश्लेषण (CIDR रेंज सपोर्ट करता है) | सत्र अस्वीकृत किया गया |
| `device_fingerprint` | डिवाइस और IP विश्लेषण | सत्र अस्वीकृत किया गया |
| `wallet_address` | लेन-देन स्क्रीनिंग | लेन-देन अस्वीकृत |
| `bank_account` | लेन-देन स्क्रीनिंग | लेन-देन अस्वीकृत |
| `user` | लेन-देन स्क्रीनिंग | उपयोगकर्ता को ब्लॉक किया गया |
| `business` | लेन-देन स्क्रीनिंग | व्यवसाय को ब्लॉक किया गया |
| `country` | वर्कफ़्लो शर्तें | कॉन्फ़िगर किया जा सकता है |
| `key` | कस्टम उपयोग | कॉन्फ़िगर किया जा सकता है |## अनुमति सूचियाँअनुमति सूचियाँ ब्लॉकलिस्ट या प्रामाणिकता जाँच को ओवरराइड नहीं करतीं। वे केवल उसी एंट्री प्रकार के लिए डुप्लीकेट/पुनः उपयोग कार्रवाइयों को रोकती हैं। उदाहरण के लिए, face अनुमति सूची में मौजूद चेहरा `DUPLICATED_FACE` कार्रवाई को छोड़ सकता है, IP अनुमति सूची में मौजूद IP `DUPLICATED_IP_ADDRESS` कार्रवाई को छोड़ सकता है, और डिवाइस अनुमति सूची में मौजूद डिवाइस फ़िंगरप्रिंट `DUPLICATED_DEVICE_FINGERPRINT` कार्रवाई को छोड़ सकता है। फिर भी Didit एक सूचनात्मक अनुमति सूची चेतावनी दर्ज करता है, ताकि आप ऑडिट कर सकें कि डुप्लीकेट कार्रवाई क्यों नहीं चली।## सिस्टम ब्लॉकलिस्टहर एप्लिकेशन को अपने-आप 10 सिस्टम ब्लॉकलिस्ट (हर समर्थित एंट्री प्रकार के लिए एक) और एक सिस्टम **High Risk Countries** सूची मिलती है। इन्हें हटाया या नाम नहीं बदला जा सकता। आप API के माध्यम से या कंसोल से इनमें एंट्री जोड़ सकते हैं।## ट्रेसेबिलिटीहर ब्लॉकलिस्ट एंट्री को उसकी स्रोत इकाई से जोड़ा जा सकता है, ताकि आप सूची से मूल रिकॉर्ड तक जा सकें:- **सत्र से**: [एंट्री बनाते समय](https://docs.didit.me/hi/management-api/lists/create-entry.md) `reference_session_id` पास करें। Didit मान (face, document, phone, email, IP या device) को अपने-आप निकालता है, अंतर्निहित मॉडल को ब्लॉकलिस्ट में चिह्नित करता है, और एंट्री को सत्र से जोड़ता है। Didit सत्र के उस प्रकार के सबसे नवीनतम रिकॉर्ड को पढ़ता है। किसी पिछले रिकॉर्ड का मान सूची में लाने के लिए, `reference_session_id` के बिना `value` से जोड़ें।
- **लेन-देन, उपयोगकर्ता या व्यवसाय से**: इकाई का UUID वाला `reference_object_uuid` पास करें और `metadata.reference_type` शामिल करें (`"transaction"`, `"vendor_user"`, या `"vendor_business"`), ताकि कंसोल मूल रिकॉर्ड से लिंक कर सके।## endpoint> [card] [सभी सूचियाँ सूचीबद्ध करें](https://docs.didit.me/hi/management-api/lists/list.md)
>
> किसी एप्लिकेशन की सभी सूचियाँ प्राप्त करें।> [card] [सूची की एंट्रियाँ](https://docs.didit.me/hi/management-api/lists/list-entries.md)
>
> किसी सूची की एंट्रियाँ प्राप्त करें।> [card] [एंट्री बनाएँ](https://docs.didit.me/hi/management-api/lists/create-entry.md)
>
> किसी ब्लॉकलिस्ट में एक मान जोड़ें: मान, सत्र संदर्भ या लेन-देन संदर्भ से।> [card] [एंट्री हटाएँ](https://docs.didit.me/hi/management-api/lists/delete-entry.md)
>
> एंट्री हटाएँ और अंतर्निहित इकाई को अनब्लॉक करें।> [card] [चेहरा अपलोड करें](https://docs.didit.me/hi/management-api/lists/upload-face.md)
>
> सीधे किसी फ़ेस ब्लॉकलिस्ट में चेहरे की इमेज अपलोड करें।


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