> ## 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 कुंजियाँ - सीमित KYC API एक्सेस

> Didit से प्रत्येक सेवा को आवश्यक एक्सेस वाली API कुंजी दें: प्रति-रिसोर्स अनुमतियाँ, वर्कफ़्लो सीमा, IP अनुमति सूची और तत्काल निरस्तीकरण।



स्कोप की गई API कुंजियों का प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\````# Goal - call Didit with a scoped API key

Every application has a primary secret with full access, and any number of named API keys.
A named key carries its own access: read or write per resource, optional limits, an optional IP allowlist and an optional expiry date.
Keys are created, edited, rotated and revoked in the Business Console (Developers -> API keys); there is no API to manage them.

\## Sending the key

\```bash
curl https://verification.didit.me/v3/session/$SESSION_ID/decision/ \
-H "x-api-key: $DIDIT_API_KEY"
\```

Read the key from an environment variable or a secrets manager, never from source code.

\## What each answer means

\| Status | Meaning |
\|---|---|
\| 401 | The key is missing, wrong, revoked or expired |
\| 403 | The key has no access to this resource or action, or the request came from an address outside its IP list |
\| 404 | The session is outside the key's workflows or statuses, so to this key it does not exist |

A key without media access receives decisions with every image, video and PDF URL set to null, and gets 403 on PDF reports.
A key without sessions write receives session_url and session_token as null.

\## Resources

sessions, decisions, media (read only), users, businesses, transactions, workflows, webhooks, applications, analytics (read only), api-keys.
Read covers GET requests, write covers POST, PUT, PATCH and DELETE.
Standalone checks (face match, ID verification, AML screening and the other /v3 standalone APIs) need sessions write.
Creating a person with send_verification_link: true (POST /v3/users/create/) needs users write and sessions write; without sessions write it answers 403 and nothing is created.

\## Limits

\- workflow_ids: only sessions of these workflows are visible, and sessions can only be created with them.
\- approved sessions only: declined, in-review and unfinished sessions are hidden.
\- A key with either limit cannot have access to users, businesses, transactions or analytics.

\## Rotation

Rotating a key returns a new secret once; the previous secret keeps working for 24 hours.````

\</pre>



      
      

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

प्रत्येक एप्लिकेशन की शुरुआत एक **प्राइमरी सीक्रेट** के साथ होती है जिसके पास एप्लिकेशन द्वारा किए जा सकने वाले सभी कार्यों का पूर्ण एक्सेस होता है।
आप इसके साथ **नामित API कुंजियाँ** जोड़ सकते हैं, प्रति सेवा या पार्टनर एक, जिनमें से प्रत्येक के पास केवल वही एक्सेस होता है जिसकी उसे आवश्यकता होती है।
अपने पेआउट प्रदाता को एक ऐसी कुंजी दें जो किसी एक वर्कफ़्लो के स्वीकृत सत्रों को पढ़ सके और कुछ भी बदल न सके, अपने बैकएंड के लिए एक अलग कुंजी रखें, और दूसरे को प्रभावित किए बिना किसी भी एक को रिवोक कर दें।> [!NOTE]
>
> स्कोप किए गए एक्सेस की सुविधा आने से पहले बनाई गई कुंजियों के पास पूर्ण एक्सेस बना रहता है।
> जब तक आप उनके एक्सेस में बदलाव नहीं करते, उनके लिए कुछ भी नहीं बदलता है।***## इन्हें कहाँ खोजें[**बिजनेस कंसोल**](https://business.didit.me) में, अपना एप्लिकेशन चुनें और **Developers -> API keys** खोलें।यह सूची एप्लिकेशन की प्रत्येक कुंजी को उसकी स्थिति, पिछले 30 दिनों में उसके अनुरोधों, इसे किसने बनाया, इसके एक्सेस और इसे पिछली बार कब उपयोग किया गया था, इसके साथ दिखाती है।
दाईं ओर इसका पूर्वावलोकन करने के लिए किसी कुंजी पर क्लिक करें, या उपयोग, एक्सेस, हाल के अनुरोधों, एक क्विकस्टार्ट स्निपेट और इसकी गतिविधि के लिए इसका पूरा पेज खोलें।कुंजियाँ किसी एक एप्लिकेशन से संबंधित होती हैं और केवल उसी के लिए काम करती हैं।
कुंजी का एनवायरनमेंट एप्लिकेशन का ही एनवायरनमेंट होता है: सैंडबॉक्स एप्लिकेशन की कुंजियाँ कभी भी बिल किए गए सत्यापन नहीं बनाती हैं।***## रीडायरेक्ट URL और अनुमत डोमेनआपके द्वारा चुने गए एप्लिकेशन और एनवायरनमेंट के लिए दो सूचियाँ सेट करने हेतु **Developers > API keys > Redirects and domains** खोलें।| सूची | यह क्या नियंत्रित करती है |
| - | - |
| **रीडायरेक्ट URL** | होस्टेड सत्यापन समाप्त होने के बाद Didit ब्राउज़र को कहाँ भेजता है। URL का पाथ सहित पूरी तरह मेल खाना आवश्यक है। |
| **अनुमत डोमेन** | वे ऑरिजिन (स्कीम, होस्ट और वैकल्पिक पोर्ट, जैसे `https://app.example.com`) जिनमें होस्टेड सत्यापन फ़्लो एम्बेड किया जा सकता है और उपयोगकर्ता को वापस भेजा जा सकता है। |जब **अनुमत डोमेन** सूची में प्रविष्टियाँ होती हैं, तो [Create session](https://docs.didit.me/hi/sessions-api/create-session.md) ऐसे `callback` को `400` एरर के साथ अस्वीकार कर देता है जो उनमें से किसी एक पर नहीं होता है।
खाली सूची का अर्थ है कोई प्रतिबंध नहीं।
सर्वर-टू-सर्वर कॉल प्रभावित नहीं होती हैं।***## कुंजी बनाएं**1. विवरण**कुंजी का नाम उस सेवा के आधार पर रखें जो इसका उपयोग करेगी, और चुनें कि इसकी समय-सीमा कब समाप्त होगी: कभी नहीं, 30 दिनों में, 90 दिनों में, एक वर्ष में, या आपके द्वारा चुनी गई तारीख पर।
समय-सीमा समाप्त कुंजी उस दिन के अंत में, UTC में काम करना बंद कर देती है।**2. एक्सेस**एक प्रीसेट से शुरुआत करें, फिर प्रति संसाधन इसे ठीक करें।
कुंजी इससे अधिक कभी कुछ नहीं कर सकती।**3. समीक्षा**कुंजी सौंपने से पहले, कंसोल स्पष्ट रूप से बताता है कि कुंजी क्या कर सकती है और क्या नहीं।**4. सीक्रेट कुंजी**सीक्रेट को कॉपी करें और इसे अपने सीक्रेट्स मैनेजर में स्टोर करें।
यह एकमात्र समय है जब पूरा सीक्रेट दिखाया जाता है।
यदि आप इसे खो देते हैं, तो एक नई कुंजी प्राप्त करने के लिए कुंजी को रोटेट करें।### प्रीसेट| प्रीसेट | एक्सेस |
| - | - |
| **पूर्ण एक्सेस** | अन्य API कुंजियों सहित प्रत्येक संसाधन, पढ़ना और लिखना। आपके अपने बैकएंड के लिए। |
| **केवल पढ़ने योग्य** | सत्र और निर्णय, मीडिया वैकल्पिक है। यह कुछ भी बना, बदल या हटा नहीं सकती। ऐसे भागीदार के लिए जिसे परिणामों की आवश्यकता है। |
| **कस्टम** | आप प्रत्येक संसाधन के लिए कोई नहीं, पढ़ना या लिखना चुनते हैं। |### संसाधनपढ़ना किसी संसाधन पर `GET` अनुरोधों को कवर करता है; लिखना `POST`, `PUT`, `PATCH` और `DELETE` को भी कवर करता है।| संसाधन | पढ़ना | लिखना |
| - | - | - |
| **सत्र** | सत्रों को सूचीबद्ध और खोलना | सत्र बनाना, अपडेट करना और हटाना, सत्र इंपोर्ट करना, और स्टैंडअलोन जांच चलाना (चेहरा मिलान, पहचान सत्यापन, AML स्क्रीनिंग और अन्य स्टैंडअलोन API) |
| **निर्णय** | परिणाम, जोखिम स्कोर, निकाला गया डेटा और AML स्क्रीनिंग इतिहास | स्वीकृत करना, अस्वीकृत करना या समीक्षा के लिए भेजना, और सुविधा व AML हिट स्थितियों को बदलना |
| **मीडिया** | ID छवियां, सेल्फ़ी, वीडियो और PDF रिपोर्टें | - |
| **लोग** (`users`) | अंतिम उपयोगकर्ता और उनके बारे में सत्यापित प्रत्येक चीज़ | उपयोगकर्ताओं को बनाना, अपडेट करना और हटाना, और उनकी निगरानी का प्रबंधन करना। सत्यापन लिंक के साथ उपयोगकर्ता बनाने के लिए **सत्र** लिखने की अनुमति भी आवश्यक है |
| **कंपनियां** (`businesses`) | व्यावसायिक प्रोफ़ाइल, उनके दस्तावेज़ और स्वामी | व्यवसायों को बनाना, अपडेट करना और हटाना, तथा उनकी निगरानी प्रबंधित करना |
| **लेन-देन** | लेन-देन, अलर्ट, नियम, निगरानी इवेंट, Travel Rule डेटा और वॉलेट स्क्रीनिंग | लेन-देन और इवेंट भेजना, उनकी स्थिति बदलना, और Travel Rule सेटिंग्स, वॉलेट पता पुस्तिका व ट्रांसफ़र प्रबंधित करना |
| **वर्कफ़्लो** | वर्कफ़्लो, प्रश्नावलियाँ, सूचियां और ब्लॉकलिस्ट | उन्हें बनाना और संपादित करना |
| **Webhook** | endpoint, और डिलीवरी (**निर्णय** पढ़ने के साथ, क्योंकि एक डिलीवरी उस सत्र payload को ले जाती है जो उसने भेजा था) | endpoint जोड़ना, संपादित करना और हटाना, और डिलीवरी फिर से भेजना |
| **एप्लिकेशन सेटिंग्स** (`applications`) | कस्टमाइज़ेशन और बैलेंस | कस्टमाइज़ेशन बदलना और बैलेंस टॉप अप करना |
| **एनालिटिक्स** | मेट्रिक्स और रिपोर्ट एक्सपोर्ट | - |
| **API कुंजियाँ** | कुंजी प्रबंधन के लिए आरक्षित | कुंजी प्रबंधन के लिए आरक्षित |कस्टम एक्सेस वाली कुंजी सार्वजनिक API पर काम करती है: सत्र, उपयोगकर्ता, व्यवसाय, लेन-देन, वर्कफ़्लो और webhook endpoints, और स्टैंडअलोन जांच।
केवल Business Console द्वारा उपयोग किए जाने वाले endpoint के लिए इसे `403` उत्तर मिलता है; उन्हें पूर्ण-एक्सेस वाली कुंजी की आवश्यकता होती है।**मीडिया** पढ़ने की अनुमति के बिना कुंजी प्रत्येक छवि, वीडियो और PDF URL को `null` पर सेट करके सत्र निर्णय प्राप्त करती है, और PDF रिपोर्ट endpoints `403` उत्तर देते हैं।
**सत्र** लिखने की अनुमति के बिना कुंजी कभी भी सत्र का सत्यापन लिंक या सत्र token प्राप्त नहीं करती है, क्योंकि जो कोई भी उन्हें रखता है वह अंतिम उपयोगकर्ता के रूप में सत्यापन पूरा कर सकता है: वे फ़ील्ड `null` के रूप में वापस आते हैं।
उसी कारण से, `send_verification_link: true` के साथ किसी व्यक्ति को बनाने के लिए **लोग** लिखने के अलावा **सत्र** लिखने की भी आवश्यकता होती है, क्योंकि यह एक सत्र बनाता है और उसका लिंक ईमेल करता है।
इसके बिना, कॉल `403` उत्तर देती है और कुछ भी नहीं बनाती है।### सीमाएं| सीमा | यह क्या करती है |
| - | - |
| **वर्कफ़्लो** | कुंजी केवल आपके द्वारा चुने गए वर्कफ़्लो के सत्र देखती है, और केवल उन्हीं के साथ सत्र बना सकती है। किसी भी अन्य सत्र के लिए `404` उत्तर मिलता है, मानो उसका कोई अस्तित्व ही न हो। |
| **केवल स्वीकृत सत्र** | अस्वीकृत, समीक्षाधीन और अधूरे सत्र कुंजी से छिपे रहते हैं। |
| **IP पते** | कुंजी केवल आपके द्वारा सूचीबद्ध पतों या CIDR श्रेणियों (20 तक, IPv4 या IPv6) से काम करती है। किसी अन्य पते से अनुरोध `403` उत्तर देते हैं। |
| **समाप्ति** | इस तारीख के बाद कुंजी के साथ किया गया प्रत्येक अनुरोध `401` उत्तर देता है। |कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित कुंजी सत्र endpoints पर काम करती है, जहाँ सीमा लागू की जा सकती है।
इसकी पहुंच लोगों, कंपनियों, लेन-देन या एनालिटिक्स तक नहीं हो सकती है, और यह स्टैंडअलोन जांच नहीं चला सकती है।***## सीमित-अधिकार वाली कुंजी को API कैसे उत्तर देती है| स्थिति | अर्थ |
| - | - |
| **401** | कुंजी गायब है, गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो चुकी है। |
| **403** | कुंजी के पास इस संसाधन या कार्रवाई तक कोई एक्सेस नहीं है, या अनुरोध इसकी IP सूची से बाहर के पते से आया है। |
| **404** | सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। |सत्र सूचियां केवल वही सत्र लौटाती हैं जिन्हें कुंजी की सीमाएं अनुमति देती हैं।***## एक्सेस संपादित करेंकिसी कुंजी का मेनू, उसका पूर्वावलोकन या उसका पेज खोलें और **एक्सेस संपादित करें** चुनें।
प्रीसेट, संसाधन, सीमाएं या समाप्ति बदलें, फिर केवल बदले हुए हिस्सों की समीक्षा करें, पहले और बाद में।
सीक्रेट वही रहता है, इसलिए कुछ भी दोबारा डिप्लॉय करने की आवश्यकता नहीं होती है, और नया एक्सेस एक मिनट के भीतर लागू हो जाता है।प्राथमिक सीक्रेट के पास हमेशा पूर्ण एक्सेस होता है और इसे संपादित नहीं किया जा सकता है।***## कुंजी रोटेट करेंरोटेट करने से कुंजी का सीक्रेट बदल जाता है।
नया सीक्रेट एक बार दिखाया जाता है, और वर्तमान सीक्रेट **24 घंटे** तक काम करता रहता है ताकि आप बिना किसी डाउनटाइम के नया सीक्रेट डिप्लॉय कर सकें।
उसके बाद, पुराने सीक्रेट के साथ किया गया प्रत्येक अनुरोध `401` उत्तर देता है।प्राथमिक सीक्रेट को उसी तरह, समान 24 घंटे के ओवरलैप के साथ रोटेट किया जाता है।***## कुंजी निरस्त करेंनिरस्त करने से कुंजी तुरंत काम करना बंद कर देती है: इसके साथ किया गया प्रत्येक अनुरोध `401` उत्तर देता है।
इसे पूर्ववत नहीं किया जा सकता।
प्राथमिक सीक्रेट को निरस्त नहीं किया जा सकता; इसके बजाय इसे रोटेट करें।***## उपयोग और ऑडिट ट्रेलप्रत्येक कुंजी पिछले 30 दिनों के अपने अनुरोध, अपनी त्रुटि दर और विलंबता, तथा अपने नवीनतम अनुरोधों को उनके स्टेटस कोड के साथ दिखाती है, जिसमें वे अनुरोध भी शामिल हैं जिन्हें इसकी सीमाओं ने अस्वीकार कर दिया था।API कुंजी के साथ की गई प्रत्येक कॉल संगठन के [ऑडिट लॉग](https://docs.didit.me/hi/console/audit-logs.md) में उस कुंजी के नाम के साथ दिखाई देती है जिसने इसे किया था।***## कुंजियों का प्रबंधन कौन कर सकता हैAPI कुंजियों के प्रबंधन के लिए **API कुंजियाँ** की अनुमति आवश्यक है: उन्हें देखने के लिए पढ़ने की अनुमति, तथा उन्हें बनाने, संपादित करने, रोटेट करने और रिवोक करने के लिए लिखने की अनुमति।
[भूमिकाएँ और अनुमतियाँ](https://docs.didit.me/hi/console/roles-permissions.md) देखें।


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