API प्रमाणीकरण: सुरक्षित KYC API अनुरोध

अपनी API कुंजी ढूँढना

Didit में, API कुंजियाँ आपके खाते के भीतर एक विशिष्ट एप्लिकेशन के लिए स्कोप्ड होती हैं। एक एप्लिकेशन एक वर्कस्पेस है जहाँ आप किसी विशेष प्रोजेक्ट या एनवायरनमेंट के लिए वर्कफ़्लो कॉन्फ़िगर कर सकते हैं और सत्यापन प्रबंधित कर सकते हैं। प्रत्येक एप्लिकेशन बनाते समय उसे पूर्ण एक्सेस वाली एक प्राइमरी API कुंजी मिलती है। आप इसके साथ और भी कुंजियाँ जोड़ सकते हैं, जिनमें से प्रत्येक के पास केवल वही एक्सेस होगा जिसकी किसी सेवा या पार्टनर को आवश्यकता है। अपनी कुंजियाँ ढूँढने के लिए:

Business Console में लॉग इन करें

Didit Business Console पर जाएँ और साइन इन करें।

अपना एप्लिकेशन चुनें

शीर्ष पर स्थित ड्रॉपडाउन मेनू से वह एप्लिकेशन चुनें जिसके साथ आप काम करना चाहते हैं।

API कुंजियाँ खोलें

बाईं ओर के साइडबार में डेवलपर -> API कुंजियाँ पर नेविगेट करें।

कुंजी कॉपी करें या बनाएँ

प्राइमरी कुंजी एप्लिकेशन का अपना सीक्रेट है। किसी सेवा या पार्टनर को उसकी ज़रूरत के अनुसार एक्सेस के साथ उसका अपना सीक्रेट देने के लिए एक नई कुंजी बनाएँ।

आपकी API कुंजी एक सीक्रेट है — इसे पासवर्ड की तरह समझें।प्राइमरी कुंजी आपके एप्लिकेशन की ओर से API तक पूर्ण एक्सेस प्रदान करती है। इसे कभी भी फ़्रंटएंड कोड, सार्वजनिक रिपॉजिटरी या क्लाइंट-साइड बंडल में उजागर न करें। इसे हमेशा केवल सर्वर-साइड रखें।

API कुंजी फ़ॉर्मेट

नई API कुंजियाँ लाइव एप्लिकेशन के लिए sk_live_ या सैंडबॉक्स एप्लिकेशन के लिए sk_test_ से शुरू होती हैं, जिसके बाद 43 URL-सुरक्षित वर्ण (अक्षर, अंक, - और _) होते हैं। इस फ़ॉर्मेट से पहले बनाई गई कुंजियों में कोई प्रीफ़िक्स नहीं होता है और वे बिना किसी बदलाव के काम करती रहती हैं। x-api-key हेडर में प्रीफ़िक्स सहित पूरी कुंजी भेजें, और किसी कुंजी को सिर्फ़ इसलिए अस्वीकार न करें क्योंकि उसमें कोई प्रीफ़िक्स नहीं है।

अपना संगठन ID ढूँढें

आपका संगठन ID वह UUID है जो आपके संगठन की पहचान करता है। आप इसका उपयोग संगठन-स्कोप्ड API पाथ जैसे /auth/v2/organizations/me/{org_id}/applications/ में करते हैं। आप इसे बिना किसी API कॉल की आवश्यकता के सीधे Business Console से कॉपी कर सकते हैं:

संगठन सेटिंग्स खोलें

Didit Business Console में, संगठन सेटिंग्स पर जाएँ।

संगठन ID कॉपी करें

संगठन ID फ़ील्ड संगठन के नाम के आगे आपके संगठन का UUID दिखाता है, जिसमें क्लिपबोर्ड पर कॉपी करने का बटन होता है।

प्रमाणीकृत अनुरोध करना

किसी API अनुरोध को प्रमाणित करने के लिए, x-api-key HTTP हेडर में अपनी सीक्रेट API कुंजी शामिल करें। यहाँ Create Session endpoint पर एक प्रमाणीकृत अनुरोध का उदाहरण दिया गया है:

cURL

curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'

एरर हैंडलिंग

यदि आपकी API कुंजी गलत, विकृत या निरस्त है, तो API 401 Unauthorized लौटाता है:

{
  "detail": "Authentication credentials were not provided or are invalid."
}

समय-सीमा समाप्त कुंजी भी "detail": "This API key has expired." के साथ 401 लौटाती है। बिना कुंजी वाला अनुरोध "detail": "You do not have permission to perform this action." के साथ 403 लौटाता है।

स्टेटस कोड	अर्थ
401	API कुंजी गलत, विकृत, निरस्त या समय-सीमा समाप्त है
403	कोई API कुंजी नहीं भेजी गई थी, कुंजी के पास अनुरोधित संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध कुंजी की IP सूची से बाहर के पते से आया है
403 `"code": "application_deleted"` के साथ	कुंजी उस एप्लिकेशन की है जिसे हटा दिया गया था। हटाए जाने के कुछ मिनटों तक API इसका रिस्पॉन्स देता है, फिर किसी भी अमान्य कुंजी की तरह इस कुंजी को अस्वीकार कर देता है। पुनः प्रयास न करें: एप्लिकेशन और उसकी कुंजियाँ अब मौजूद नहीं हैं।
404	सत्र रूट पर: सत्र कुंजी के वर्कफ़्लो या स्थितियों के बाहर है

API एरर पेज हर स्टेटस, बॉडी और कोड को सूचीबद्ध करता है।

स्कोप्ड API कुंजियाँ

प्राइमरी कुंजी साझा करने के बजाय प्रत्येक सेवा या पार्टनर को उसकी अपनी कुंजी दें। प्रत्येक कुंजी का अपना एक्सेस होता है: प्रत्येक संसाधन (सत्र, निर्णय, मीडिया, लोग, कंपनियाँ, लेन-देन, वर्कफ़्लो, webhook, एप्लिकेशन सेटिंग्स, एनालिटिक्स) के लिए कोई एक्सेस नहीं, पढ़ने या लिखने का एक्सेस; साथ ही, कुछ वर्कफ़्लो तक, केवल स्वीकृत सत्रों तक, IP पतों की सूची तक और समाप्ति तिथि तक पहुँच सीमित करने के वैकल्पिक विकल्प होते हैं। आप 24 घंटे के ओवरलैप के साथ कुंजी को रोटेट कर सकते हैं, और इसे तुरंत निरस्त कर सकते हैं। स्कोप्ड एक्सेस उपलब्ध होने से पहले बनाई गई कुंजियों के पास पूर्ण एक्सेस बना रहता है। प्रीसेट, प्रत्येक द्वारा कवर किए जाने वाले संसाधनों, और API द्वारा स्कोप्ड कुंजी का रिस्पॉन्स कैसे दिया जाता है, इसके लिए API कुंजियाँ देखें।

यदि आपको 401 एरर प्राप्त होता है, तो दोबारा जाँच लें कि आप सही एप्लिकेशन के लिए सही API कुंजी का उपयोग कर रहे हैं और इसे फिर से जनरेट नहीं किया गया है।

अवलोकन

मूल्य निर्धारण

वर्कफ़्लो और सत्यापन

समीक्षा और संचालन

एंटिटी (उपयोगकर्ता और व्यवसाय)

सेटिंग्स और कस्टमाइज़ेशन

सुरक्षा और अनुपालन

Didit Academy

संसाधन

API प्रमाणीकरण: सुरक्षित KYC API अनुरोध

अपनी API कुंजी ढूँढना

API कुंजी फ़ॉर्मेट

अपना संगठन ID ढूँढें

प्रमाणीकृत अनुरोध करना

एरर हैंडलिंग

स्कोप्ड API कुंजियाँ

​अपनी API कुंजी ढूँढना

​API कुंजी फ़ॉर्मेट

​अपना संगठन ID ढूँढें

​प्रमाणीकृत अनुरोध करना

​एरर हैंडलिंग

​स्कोप्ड API कुंजियाँ

अपनी API कुंजी ढूँढना

API कुंजी फ़ॉर्मेट

अपना संगठन ID ढूँढें

प्रमाणीकृत अनुरोध करना

एरर हैंडलिंग

स्कोप्ड API कुंजियाँ