> ## 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. # Blocklist ve Allowlist में एंट्री बनाएँ API | Didit > Didit की blocklist, allowlist या कस्टम सूची में चेहरा, दस्तावेज़, IP, वॉलेट, ईमेल या फ़ोन की एंट्री जोड़ें। प्रोग्रामैटिक अनुपालन और धोखाधड़ी नियंत्रण। सूची में एंट्री बनाने का API प्रॉम्प्ट प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें \

\`Add an entry to a Didit list (blocklist, allowlist, or custom) through the Management API.

Endpoint:
POST 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: write.

Goal:
\- Insert a single entry into a list. Three add modes are supported:
1\. By value: pass value matching the list's entry_type.
2\. From a verification session: pass reference_session_id and Didit reads the value from the session's most recent record of the list's entry_type (face, document, phone, email, ip_address, device_fingerprint) and links the entry to the session.
3\. With a source reference: pass value plus reference_object_uuid and metadata.reference_type so the console links the entry back to the transaction, user or business it came from.

Path parameter:
\- list_uuid: list UUID from GET /v3/lists/. For a face without a session, use POST /v3/lists/{list_uuid}/entries/face-upload/ instead.

Request body (application/json):
\{
"value": "string",                  // required unless reference_session_id is sent
"reference_session_id": "uuid",     // optional: read the value from this session of my application
"reference_object_uuid": "uuid",    // optional: transaction UUID, or didit_internal_id of a user or business
"face_image_source": "liveness" | "front_image_camera_front" | "back_image_camera_front", // optional, system face blocklist + reference_session_id only; default liveness
"reference_node_id": "string",      // optional, with a document-capture face_image_source: which ID verification node's selfie to use
"display_label": "string",          // optional, at most 512 characters
"comment": "string",                // optional, reason or note
"metadata": {                       // optional, free-form; reference_image_url and front_image_url are ignored
"reference_type": "transaction" | "vendor_user" | "vendor_business",
"reference_id": "uuid"
}
}

Value validation by entry_type:
\- email: valid email address.
\- phone: valid international phone number (stored in E.164).
\- ip_address: IP address 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-2 or alpha-3 (stored as alpha-3).
\- user, business: the vendor_data to block.
\- face, document, wallet_address, bank_account, key: any non-empty string.
Values are case-insensitive: country codes are stored in upper case, phone numbers in E.164, everything else in lower case.
A list holds each value once: adding a value that is already there returns 400.

Adding from a session, what Didit does:
\- Looks up the session (it must belong to the same application).
\- Reads the value from the session's most recent record of the list's entry_type:
\- face: the liveness face (value is the face UUID). With face_image_source = front_image_camera_front / back_image_camera_front, the face from the selfie the front camera took while the user photographed the front / back of their document instead (system face blocklist only, leave value empty).
\- document: the document number; full_name, issuing_state, document_type, region and document_number go into metadata.
\- phone / email: the phone number / email address.
\- ip_address: the session's IP address.
\- device_fingerprint: a fingerprint that identifies one device. On a blocklist, Didit refuses a session that only has a device-class fingerprint or was completed on more than one device; pass the exact fingerprint as value in that case.
\- Links the entry to the session (reference_session_id) and to that record (reference_object_uuid).
\- If I also send value, Didit stores my value but still links the most recent record. To list a value from an earlier record, add it by value without reference_session_id.

Example calls:
\# By value
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'

\# From a session
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777"}'

\# The face from the selfie taken during document capture (system face blocklist)
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front"}'

\# From a transaction
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": {"reference_type": "transaction"}}'

Failure modes:
\- 400: value fails the entry_type validator or is already in the list, neither value nor reference_session_id was sent, reference_session_id is not a session of this application, or the session has no data of the list's entry_type.
\- 400 (face_image_source): the list is not the system face blocklist, value was sent, the session has no image for that source, no clear face was found in that selfie, or that selfie is already in the blocklist.
\- 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: write.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503 (face_image_source): face analysis is temporarily unavailable; nothing was added, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- System face, document, phone and email blocklists: a record read from a session is flagged as blocklisted at once, and new sessions that match it are declined.
\- System user and business blocklists: users or businesses of the application whose vendor_data equals value (or whose UUID equals reference_object_uuid) are set to BLOCKED.
\- Sessions and transactions that already finished are not changed.

For the full integration shape, see /integration/integration-prompt.`

\
यहाँ पेस्ट करें सूची में एक एंट्री जोड़ें। मान की जाँच सूची के एंट्री प्रकार के अनुसार की जाती है:* **email**: एक मान्य ईमेल पता * **phone**: एक मान्य अंतरराष्ट्रीय फ़ोन नंबर, जो E.164 में संग्रहीत होता है (उदाहरण के लिए `+14155552671`) * **ip\_address**: एक मान्य IP पता या CIDR रेंज (जैसे `192.168.1.1` या `10.0.0.0/8`) * **device\_fingerprint**: अक्षरों, अंकों, `-`, `_`, `:` और `.` में से कम से कम 8 वर्ण। ब्लॉकलिस्ट ऐसे फ़िंगरप्रिंट को अस्वीकार करती है जिसे कई अलग-अलग डिवाइसों ने रिपोर्ट किया हो, क्योंकि उसे ब्लॉक करने से असंबंधित लोग भी रुक जाएँगे। * **country**: एक मान्य [ISO 3166-1 alpha-3 देश कोड](https://docs.didit.me/hi/core-technology/id-verification/supported-documents-id-verification.md) (जैसे `USA`, `GBR`, `ESP`)। alpha-2 कोड (जैसे `US`) स्वीकार किए जाते हैं और अपने-आप alpha-3 में बदल दिए जाते हैं। * **user**, **business**: उपयोगकर्ता या व्यवसाय का `vendor_data` * **face**, **document**, **wallet\_address**, **bank\_account**, **key**: कोई भी खाली न हो, ऐसी कोई स्ट्रिंग> [!NOTE] > > सभी एंट्री मान **केस-इनसेंसिटिव** होते हैं। आप जो मान भेजते हैं, वे संग्रहीत करते समय सामान्यीकृत किए जाते हैं (फ़ोन नंबर E.164 में, देश कोड बड़े अक्षरों में, बाकी सब छोटे अक्षरों में) और सत्यापन के दौरान केस-इनसेंसिटिव तरीके से मिलाए जाते हैं। उदाहरण के लिए, `User@Example.COM` को ब्लॉक करने पर `user@example.com` भी पकड़ा जाएगा। एक सूची में हर मान केवल एक बार रहता है: सूची में पहले से मौजूद मान जोड़ने पर `400` लौटता है।चेहरे के लिए, जब आपके पास केवल इमेज हो तो [Upload face](https://docs.didit.me/hi/management-api/lists/upload-face.md) का उपयोग करें, या किसी मौजूदा सत्र का चेहरा लेने के लिए `reference_session_id` भेजें। चेहरे की एंट्री के लिए संग्रहीत चेहरा चाहिए जिससे मिलान किया जा सके, और टाइप किया गया `value` वह उपलब्ध नहीं कराता।## सत्र से जोड़नाजब आप `reference_session_id` देते हैं, तो Didit:1) सत्र खोजता है (वह उसी एप्लिकेशन का होना चाहिए) 2) सत्र में सूची के एंट्री प्रकार के **सबसे हाल के** रिकॉर्ड से मान पढ़ता है: * **face**: लाइवनेस सेल्फ़ी का चेहरा; `value` चेहरे का UUID है * **document**: दस्तावेज़ संख्या; पूरा नाम, जारी करने वाला राज्य, दस्तावेज़ प्रकार, क्षेत्र और दस्तावेज़ संख्या `metadata` में संग्रहीत होते हैं, और `display_label` डिफ़ॉल्ट रूप से धारक का नाम और दस्तावेज़ संख्या होता है * **phone**: फ़ोन नंबर * **email**: ईमेल पता * **ip\_address**: सत्र का IP पता * **device\_fingerprint**: एक ऐसा फ़िंगरप्रिंट जो एक डिवाइस की पहचान करे, जिसमें वह डिवाइस प्राथमिकता पाए जिसने सत्यापन का कोई चरण पूरा किया हो। ब्लॉकलिस्ट पर, Didit ऐसे सत्र को अस्वीकार करता है जिसमें केवल डिवाइस-क्लास फ़िंगरप्रिंट हो, या जो एक से अधिक डिवाइसों पर पूरा हुआ हो: इन स्थितियों में सटीक फ़िंगरप्रिंट `value` के रूप में भेजें। 3) एंट्री को ट्रेसेबिलिटी के लिए सत्र (`reference_session_id`) और रिकॉर्ड (`reference_object_uuid`) से लिंक करता हैसिस्टम की चेहरा, दस्तावेज़, फ़ोन और ईमेल ब्लॉकलिस्ट पर, रिकॉर्ड को ब्लॉकलिस्टेड भी चिह्नित किया जाता है, ताकि उससे मेल खाने वाले नए सत्र अस्वीकार हों। किसी भी अन्य एंट्री प्रकार के लिए, `value` भी भेजें।`400` लौटता है अगर सत्र नहीं मिलता या उसमें अनुरोधित एंट्री प्रकार का डेटा नहीं है।### दस्तावेज़ कैप्चर सेल्फ़ी से चेहरेजब उपयोगकर्ता अपने दस्तावेज़ की फ़ोटो खींच रहा होता है, तब फ्रंट कैमरा उसकी सेल्फ़ी ले सकता है ([पहचान सत्यापन रिपोर्ट](https://docs.didit.me/hi/core-technology/id-verification/report-id-verification.md) की `front_image_camera_front` और `back_image_camera_front` इमेज)। वह चेहरा लाइवनेस वाले चेहरे के साथ-साथ चेहरा ब्लॉकलिस्ट में भी जोड़ा जा सकता है: जो इमेज चाहिए उसके साथ `face_image_source` पास करें।```json theme={null} { "reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front" } ```- एंट्री केवल सिस्टम की **चेहरा ब्लॉकलिस्ट** में बनती है, और `value` खाली छोड़ना होगा: Didit सत्र की सेल्फ़ी से चेहरा लेता है। - सेल्फ़ी में एक साफ़ चेहरा होना चाहिए। अगर न हो, तो अनुरोध `400` लौटाता है और कुछ नहीं जोड़ा जाता। - हर सेल्फ़ी एक बार ही जोड़ी जा सकती है। एंट्री का `metadata.face_image_source` और `metadata.reference_node_id` बताते हैं कि वह किस सेल्फ़ी से आई है। - एक से अधिक पहचान सत्यापन चरण वाले वर्कफ़्लो में, `reference_node_id` वह चरण चुनता है जिसकी सेल्फ़ी इस्तेमाल हो। डिफ़ॉल्ट रूप से Didit वह सबसे हाल का पहचान सत्यापन इस्तेमाल करता है जिसमें वह सेल्फ़ी हो। - इसके बाद चेहरे की जाँच किसी भी ब्लॉकलिस्टेड चेहरे की तरह होती है: हर नए सत्र की लाइवनेस सेल्फ़ी से, और हर नई दस्तावेज़-कैप्चर सेल्फ़ी से (देखें [`FRONT_CAMERA_FACE_IN_BLOCKLIST`](https://docs.didit.me/hi/core-technology/id-verification/warnings-id-verification))। - एंट्री हटाने पर चेहरा ब्लॉकलिस्ट से हट जाता है, और नए सत्रों से मेल खाना बंद कर देता है।### एक ही प्रकार के कई रिकॉर्ड वाले सत्रएक सत्र में किसी प्रकार के एक से अधिक रिकॉर्ड हो सकते हैं, जैसे मल्टी-स्टेप वर्कफ़्लो से दो फ़ोन नंबर। Didit हमेशा **सबसे हाल का** रिकॉर्ड पढ़ता है। अगर आप `reference_session_id` के साथ `value` भी भेजते हैं, तो एंट्री आपका `value` संग्रहीत करती है, पर वह फिर भी उसी सबसे हाल के रिकॉर्ड से लिंक रहती है, और सिस्टम ब्लॉकलिस्ट पर वही रिकॉर्ड चिह्नित होता है।किसी पिछले रिकॉर्ड का मान सूची में डालने के लिए, उसे केवल `value` से जोड़ें, `reference_session_id` के बिना:```json theme={null} { "value": "+34612345678", "comment": "First phone number of session 42" } ```## लेन-देन, उपयोगकर्ताओं और व्यवसायों का संदर्भजब किसी लेन-देन या वेंडर उपयोगकर्ता/व्यवसाय का डेटा ब्लॉकलिस्ट करते हैं, तो इकाई का UUID `reference_object_uuid` के रूप में दें और `metadata` में स्रोत प्रकार बताएँ:```json theme={null} { "value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" } } ```इससे आप ब्लॉकलिस्ट एंट्री से कंसोल में मूल लेन-देन, उपयोगकर्ता या व्यवसाय तक पहुँच सकते हैं। Didit आपकी `metadata` की कुंजियाँ संग्रहीत करता है, सिवाय `reference_image_url` और `front_image_url` के, जिन्हें केवल Didit सेट करता है। सत्र से पढ़ी गई एंट्री के लिए, Didit अपनी कुंजियाँ आपकी कुंजियों में जोड़ता है, और जब दोनों में टकराव हो तो उसकी कुंजियाँ ही प्राथमिकता पाती हैं।| स्रोत इकाई | `reference_object_uuid` | `metadata.reference_type` | | - | - | - | | सत्यापन सत्र | Didit द्वारा सेट (चेहरा, दस्तावेज़, फ़ोन या ईमेल रिकॉर्ड) | ज़रूरत नहीं: `reference_session_id` इस्तेमाल करें | | लेन-देन | लेन-देन UUID | `"transaction"` | | वेंडर उपयोगकर्ता | `didit_internal_id` | `"vendor_user"` | | वेंडर व्यवसाय | `didit_internal_id` | `"vendor_business"` |सिस्टम की **उपयोगकर्ता** और **व्यवसाय** ब्लॉकलिस्ट पर, Didit मेल खाने वाले उपयोगकर्ताओं या व्यवसायों को भी `BLOCKED` सेट करता है: वे जिनका `vendor_data`, `value` के बराबर है, या जिनका `didit_internal_id`, `reference_object_uuid` के बराबर है। देखें [उपयोगकर्ता ब्लॉकलिस्ट](https://docs.didit.me/hi/entities/users/blocklist.md) और [व्यवसाय ब्लॉकलिस्ट](https://docs.didit.me/hi/entities/businesses/blocklist.md)। ## OpenAPI ````yaml hi/openapi-25.json POST /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/: post: tags: - Lists summary: एक सूची प्रविष्टि बनाएँ description: >- किसी सूची में तीन तरीकों में से किसी एक से एक प्रविष्टि जोड़ता है: `value` द्वारा; `reference_session_id` वाले सत्यापन सत्र से, जहाँ Didit सत्र में सूची के प्रविष्टि प्रकार के सबसे हालिया रिकॉर्ड से मान पढ़ता है और प्रविष्टि को उससे लिंक करता है; या किसी लेन-देन, उपयोगकर्ता या व्यवसाय की ओर वापस इंगित करने वाले `reference_object_uuid` और `metadata.reference_type` के साथ `value` द्वारा। सिस्टम फ़ेस, दस्तावेज़, फ़ोन और ईमेल ब्लॉकलिस्ट पर, सत्र से पढ़े गए रिकॉर्ड को ब्लॉकलिस्टेड के रूप में भी फ़्लैग किया जाता है, जिससे नए मेल खाने वाले सत्र अस्वीकृत हो जाते हैं; सिस्टम उपयोगकर्ता और व्यवसाय ब्लॉकलिस्ट पर, मेल खाने वाले उपयोगकर्ताओं या व्यवसायों को `BLOCKED` पर सेट किया जाता है। पहले ही समाप्त हो चुके सत्र और लेन-देन नहीं बदले जाते हैं। स्कोप्ड API कुंजी को `workflows: write` की आवश्यकता होती है। प्रत्येक मोड के लिए [सूची प्रविष्टि बनाएँ](https://docs.didit.me/hi/management-api/lists/create-entry) देखें। operationId: create_list_entry parameters: - name: list_uuid in: path required: true description: >- जिस सूची में जोड़ना है उसका UUID। ऐसे चेहरे के लिए जो आपके पास केवल एक छवि के रूप में है, इसके बजाय Upload a face to a list का उपयोग करें। schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object description: >- `value`, `reference_session_id`, या दोनों भेजें। कौन से फ़ील्ड लागू होते हैं यह सूची के `entry_type` पर निर्भर करता है। properties: value: type: string description: >- सूचीबद्ध करने योग्य मान, जिसे सूची के `entry_type` के विरुद्ध मान्य किया गया है: `email` एक मान्य ईमेल पता; `phone` एक मान्य अंतर्राष्ट्रीय नंबर, जो E.164 में संग्रहीत है; `ip_address` एक IP पता या CIDR रेंज (उदाहरण के लिए `10.0.0.0/8`); `device_fingerprint` अक्षरों, अंकों, `-`, `_`, `:` और `.` में से कम से कम 8 वर्ण (एक ब्लॉकलिस्ट उस फ़िंगरप्रिंट को अस्वीकार कर देती है जिसे कई अलग-अलग डिवाइसों ने रिपोर्ट किया है); `country` एक ISO 3166-1 alpha-2 या alpha-3 कोड, जो alpha-3 के रूप में संग्रहीत है; `user` और `business` `vendor_data`; कोई अन्य प्रकार एक गैर-रिक्त स्ट्रिंग। फ़ोन नंबरों और देश कोडों को छोड़कर लोअरकेस में संग्रहीत किया जाता है, और एक सूची प्रत्येक मान को एक बार रखती है (केस-असंवेदनशील)। जब तक `reference_session_id` नहीं भेजा जाता तब तक आवश्यक है; दस्तावेज़-कैप्चर `face_image_source` के साथ इसे खाली छोड़ दिया जाना चाहिए। reference_session_id: type: string format: uuid description: >- आपके एप्लिकेशन का एक व्यक्ति या व्यवसाय सत्यापन सत्र जिससे मान लिया जाना है। Didit सूची के प्रविष्टि प्रकार (`face`, `document`, `phone`, `email`, `ip_address` या `device_fingerprint`) से संबंधित सत्र के सबसे हालिया रिकॉर्ड को पढ़ता है, प्रविष्टि को सत्र और उस रिकॉर्ड से लिंक करता है, और दस्तावेज़ों के लिए `display_label` और `metadata` भरता है। `device_fingerprint` ब्लॉकलिस्ट के लिए, ऐसा सत्र जिसमें केवल डिवाइस-क्लास फ़िंगरप्रिंट है, या जो एक से अधिक डिवाइस पर पूरा किया गया था, अस्वीकार कर दिया जाता है: सटीक फ़िंगरप्रिंट को `value` के रूप में भेजें। अन्य प्रविष्टि प्रकारों के लिए, या जब सत्र में ऐसा कोई रिकॉर्ड न हो, तो `value` भी भेजें; तब आपका `value` संग्रहीत किया जाता है और प्रविष्टि अभी भी सत्र से लिंक रहती है। reference_object_uuid: type: string format: uuid description: >- उस रिकॉर्ड का UUID जिसके लिए प्रविष्टि है, जब यह किसी सत्र से नहीं आती है: लेन-देन का UUID, या किसी उपयोगकर्ता या व्यवसाय का `didit_internal_id`। इसे `metadata.reference_type` के साथ जोड़ें। जब `reference_session_id` कोई रिकॉर्ड प्रदान करता है, तो इसे सत्र के रिकॉर्ड से बदल दिया जाता है। face_image_source: type: string enum: - liveness - front_image_camera_front - back_image_camera_front default: liveness description: >- `reference_session_id` वाली फ़ेस सूचियाँ: सत्र की किन छवियों से चेहरा लिया गया है। `liveness` (डिफ़ॉल्ट) लाइवनेस सेल्फ़ी है। `front_image_camera_front` और `back_image_camera_front` वे सेल्फ़ी हैं जो सामने वाले कैमरे ने तब ली थीं जब उपयोगकर्ता ने अपने दस्तावेज़ के आगे या पीछे के हिस्से की तस्वीर खींची थी: इन्हें केवल सिस्टम फ़ेस ब्लॉकलिस्ट पर स्वीकार किया जाता है, `reference_session_id` और एक खाली `value` के साथ। प्रत्येक सेल्फ़ी को एक बार जोड़ा जा सकता है और इसमें एक स्पष्ट चेहरा दिखना चाहिए। reference_node_id: type: string nullable: true maxLength: 100 description: >- दस्तावेज़-कैप्चर `face_image_source` के साथ: पहचान सत्यापन नोड जिसकी सेल्फ़ी का उपयोग किया जाना है, एक से अधिक पहचान सत्यापन नोड वाले वर्कफ़्लो के लिए। डिफ़ॉल्ट रूप से सबसे हालिया पहचान सत्यापन जिसमें वह छवि है। `liveness` के साथ अस्वीकृत। display_label: type: string maxLength: 512 description: >- मानव-पठनीय लेबल। खाली होने पर, Didit जहाँ संभव हो सत्र से इसे प्राप्त करता है (उदाहरण के लिए धारक का नाम और दस्तावेज़ संख्या)। comment: type: string description: मुक्त-पाठ नोट, जैसे सूचीबद्ध करने का कारण। metadata: type: object additionalProperties: true description: >- प्रविष्टि के साथ संग्रहीत और संग्रहीत रूप में ही लौटाया गया फ़्री-फ़ॉर्म JSON। `reference_type` और `reference_id` का उपयोग करें ताकि कंसोल वापस स्रोत से लिंक हो सके। `reference_image_url` और `front_image_url` केवल Didit द्वारा सेट किए जाते हैं और यदि आप उन्हें भेजते हैं तो उन्हें छोड़ दिया जाता है। किसी सत्र से पढ़ी गई प्रविष्टि के लिए, Didit की कुंजियों को आपकी कुंजियों के साथ मर्ज कर दिया जाता है। properties: reference_type: type: string enum: - transaction - vendor_user - vendor_business description: '`reference_object_uuid` किस ओर इंगित करता है।' reference_id: type: string description: स्रोत रिकॉर्ड का पहचानकर्ता। examples: By value: value: value: '+14155552671' comment: Reported fraud From a session: value: reference_session_id: 33333333-4444-5555-6666-777777777777 Face from a document-capture selfie: value: reference_session_id: 33333333-4444-5555-6666-777777777777 face_image_source: front_image_camera_front From a transaction: value: value: '0x52908400098527886E0F7030069857D2E4169EE7' reference_object_uuid: 55555555-6666-7777-8888-999999999999 comment: Linked to a chargeback metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 Country: value: value: PRK comment: Sanctioned jurisdiction responses: '201': description: एंट्री बनाई गई थी। content: application/json: schema: $ref: '#/components/schemas/ComplianceListEntry' examples: By value: value: uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee value: '+14155552671' display_label: '' comment: Reported fraud 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-12T10:04:51.220391Z' Document from a session: value: 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' From a transaction: value: uuid: dddddddd-eeee-ffff-0000-111111111111 value: '0x52908400098527886e0f7030069857d2e4169ee7' display_label: '' comment: Linked to a chargeback added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: 55555555-6666-7777-8888-999999999999 metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 created_at: '2026-10-12T10:20:40.117062Z' '400': description: >- बॉडी अमान्य है, मान पहले से ही सूची में है, या सत्र मान प्रदान नहीं कर सकता है। content: application/json: examples: Nothing to list: value: value: - >- Either 'value' or 'reference_session_id' must be provided. Duplicate value: value: value: - An entry with this value already exists in this list. Invalid phone: value: value: - >- Invalid phone number. Provide a valid international number (e.g. +1234567890). Invalid IP: value: value: - >- Invalid IP address or CIDR range (e.g. 192.168.1.1 or 10.0.0.0/24). Invalid country: value: value: - >- Invalid country code: XX. Provide a valid ISO 3166-1 alpha-2 or alpha-3 country code. Device-class fingerprint: value: value: - >- This value is a device-class fingerprint: several distinct devices have reported it, so blocklisting it would decline unrelated people. Block the user by document, face, email or phone instead. Unknown session: value: reference_session_id: - >- Session not found or does not belong to this application. No data in session: value: value: - >- Either provide a 'value' or ensure the session contains data for this entry type. Selfie on another list: value: face_image_source: - >- A document-capture selfie can only be added to the face blocklist. No clear face in selfie: value: face_image_source: - >- No clear face was found in this selfie, so it cannot be blocklisted. Selfie already listed: value: face_image_source: - This selfie is already in the blocklist. '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: write` की कमी है या इसका उपयोग इसकी अनुमति सूची से बाहर के किसी 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 write access to workflows. '404': description: >- API कुंजी के एप्लिकेशन में इस UUID वाली कोई सूची मौजूद नहीं है, या इसे हटा दिया गया था। content: application/json: examples: Not found: value: detail: List not found. '429': $ref: '#/components/responses/RateLimitedWrite' '503': description: >- दस्तावेज़-कैप्चर सेल्फ़ी का चेहरा विश्लेषण अस्थायी रूप से अनुपलब्ध है। कुछ भी नहीं जोड़ा गया; बाद में पुनः प्रयास करें। content: application/json: examples: Unavailable: value: detail: Service temporarily unavailable. Please try again later. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"value": "+14155552671", "comment": "Reported fraud"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.entries.create( "11111111-2222-3333-4444-555555555555", value="+14155552671", comment="Reported fraud", ) 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.entries.create("11111111-2222-3333-4444-555555555555", { value: "+14155552671", comment: "Reported fraud", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue: didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.ListsEntriesCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().entries().create("11111111-2222-3333-4444-555555555555", ListsEntriesCreateParams.builder() .value("+14155552671") .comment("Reported fraud") .build()); System.out.println(result); - lang: php label: PHP source: >- lists->entries->create('11111111-2222-3333-4444-555555555555', [ 'value' => '+14155552671', 'comment' => 'Reported fraud', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.entries.create( "11111111-2222-3333-4444-555555555555", value: "+14155552671", comment: "Reported fraud" ) 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.Entries.CreateAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesCreateParams { Value = "+14155552671", Comment = "Reported fraud", }); Console.WriteLine(JsonSerializer.Serialize(result)); 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: जब प्रविष्टि जोड़ी गई थी। responses: RateLimitedWrite: description: >- प्रति API कुंजी प्रति मिनट 300 अनुरोधों की साझा लिखने की सीमा पार हो गई। पुनः प्रयास करने से पहले `Retry-After` का पालन करें। content: application/json: schema: type: object required: - detail properties: detail: type: string example: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. 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.