API संदर्भ
हर endpoint, हर फ़ील्ड, हर वह त्रुटि जिसकी आप योजना बना सकते हैं।
डेवलपर्स
Identity verification API दस्तावेज़ीकरण, जो सच में इस्तेमाल के लिए बना है।
एक REST API, उन हिस्सों के लिए एक होस्टेड पेज जिन्हें आप ख़ुद नहीं बनाना चाहते, और हस्ताक्षरित webhooks ताकि परिणाम आते ही आपको पता चल जाए। Sandbox keys का कभी बिल नहीं बनता, इसलिए ShieldID को समझने का सबसे तेज़ तरीक़ा उसे कॉल करना है।
पाँच मिनट का संस्करण
चार कॉल। एक सरल मॉडल।
इन दस्तावेज़ों में बाक़ी सब कुछ इसी चक्र का विस्तार है।
सत्र बनाएँ
return URL और webhook URL के साथ POST /v1/sessions करें। बदले में आपको एक session_id और एक verification_url मिलेगा।इसे आवेदक को सौंपें
verification_url को लिंक के रूप में भेजें, या डेस्कटॉप पर होस्टेड पेज में दिखने वाला QR कोड उन्हें स्कैन करने दें। वे अपने ही फ़ोन पर प्रक्रिया पूरी करते हैं।हस्ताक्षरित webhook प्राप्त करें
जब सत्र VERIFIED या FAILED तक पहुँचता है, तो ShieldID परिणाम को आपके webhook URL पर POST करता है, हस्ताक्षरित ताकि आप भरोसा कर सकें कि वह हमसे आया है।परिणाम पढ़ें
webhook पर भरोसा करें, या GET /v1/sessions/{id}/result ख़ुद कॉल करें। दोनों तरह से आपको हर जाँच का अलग निर्णय मिलता है, एक अस्पष्ट स्कोर नहीं।
आज़माएँ
अपना पहला सेशन बनाएँ।
तीन भाषाओं में वही अनुरोध। यह वही कॉल है जिसका वर्णन मानसिक मॉडल का पहला चरण करता है।
bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
-H "X-Api-Key: vk_sand_your_key" \
-H "Content-Type: application/json" \
-d '{
"return_url": "https://yourapp.example/verified",
"webhook_url": "https://yourapp.example/hooks/shieldid"
}'
# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }Sandbox keys (vk_sand_…) यही फ़्लो मुफ़्त चलाती हैं। vk_live_ key लगाएँ और इनवॉइस के सिवा कुछ नहीं बदलता।
अपना रास्ता खोजें
बाक़ी डेवलपर दस्तावेज़।
छह पेज। जो चाहिए वही पढ़ें।
क्विकस्टार्ट
Sandbox key से पहले हस्ताक्षरित webhook तक, क्रम से।
SDKs
वेब widget, होस्टेड फ़्लो, और आगे क्या आ रहा है।
Sandbox
टेस्ट मोड कैसे काम करता है, और key कैसे पाएँ।
स्थिति
फ़ीड लाइव होने पर हम किस बारे में रिपोर्ट करेंगे।
चेंजलॉग
क्या जारी हुआ, और कब।
Sandbox
किसी भी चीज़ पर हस्ताक्षर करने से पहले पूरे फ़्लो को आज़मा लें।
sandbox key (प्रीफ़िक्स vk_sand_) प्रोडक्शन जैसा ही API, hosted पेज और webhook फ़्लो चलाती है। सेशन जहाँ भी दिखते हैं, वहाँ उन पर environment: "sandbox" की मुहर लगी होती है, और sandbox सेशन किसी भी प्लान पर कभी बिल नहीं किए जाते।
- असली सेशन बनाएँ, अपने फ़ोन पर एक असली दस्तावेज़ सत्यापित करें, और बदले में एक असली हस्ताक्षरित webhook पाएँ
- sandbox में आप जो भी करें, उसका असर किसी इनवॉइस पर नहीं पड़ता
- सिर्फ़ key का प्रीफ़िक्स बदलकर प्रोडक्शन पर जाएँ; अनुरोध का स्वरूप नहीं बदलता
खुलेपन के साथ बना
क्या तैयार है, और क्या अभी नहीं।
हम चाहेंगे कि आपको हम खुद बताएँ, न कि आपको इंटीग्रेशन के बीच में पता चले।
वेब widget के completion callbacks
जल्द आ रहा हैonComplete, onCancel और onStep आज widget के इंटरफ़ेस में मौजूद हैं, लेकिन अभी कुछ भी इन्हें ट्रिगर नहीं करता। return URL और webhook का उपयोग करें — दोनों अभी काम करते हैं।
लागू की गई rate limits
जल्द आ रहा हैहर API key पर आपके प्लान के अनुसार एक rate limit दर्ज है, लेकिन अनुरोधों पर यह अभी लागू नहीं की गई है — इसलिए अपनी योजना उसी हिसाब से बनाएँ, और अनुरोधों को सीमित करने के लिए ShieldID पर निर्भर न रहें।
self-serve sandbox साइनअप
जल्द आ रहा हैself-serve साइनअप तैयार होने तक sandbox keys अनुरोध पर जारी की जाती हैं। माँगिए, और हम जल्दी से एक उपलब्ध करा देंगे।
प्रश्न
डेवलपर्स के लिए सीधे जवाब।
शुरू करें
एक दोपहर में लाइव हो जाएँ।
sandbox key से शुरू करें, अपने फ़ोन पर एक वेरिफ़िकेशन चलाएँ, और उससे मिलने वाला webhook पढ़ें। किसी सेल्स कॉल की ज़रूरत नहीं।
Sandbox सेशन का कभी बिल नहीं बनता।