मुख्य सामग्री पर जाएं
POST
curl
प्रोडक्शन में खाता जाँच नाइजीरिया, घाना और केन्या में चलती है। कोई अन्य देश 404 के साथ code: country_not_covered लौटाता है और उस पर कोई शुल्क नहीं लगता। समय के साथ और देश जुड़ेंगे, और बैंक सत्यापन मूल्य निर्धारण में हमेशा दिखता है कि आज हर देश में क्या उपलब्ध है।
आपका बैकएंड नाम और खाता भेजता है, और परिणाम पढ़ता है। यह बैंक सत्यापन चरण की खाता जाँच है, जिसमें व्यक्ति शामिल नहीं होता।

खाता उसी तरह भेजें जैसे उसे उसके देश में लिखा जाता है

कुछ देश bic भी माँगते हैं, और व्यावसायिक खाते के लिए registration_id। स्पेस, डैश और बिंदु अनदेखे किए जाते हैं। जो कुंजी देश की जाँच को चाहिए और आप नहीं भेजते, उसके लिए 400 मिलता है जो उसका नाम बताता है, जैसे "field": "account.bank_code", "reason": "required"। किसी व्यक्ति के खाते की जाँच के लिए holder.full_name भेजें, और किसी कंपनी के खाते की जाँच के लिए holder.business_name।

खाताधारक की सहमति भेजें

कुछ देशों में खाता जाँच से पहले हर जाँच के लिए खाताधारक की स्पष्ट सहमति चाहिए। अपने उत्पाद में सहमति लें, फिर "consent": true भेजें। इसके बिना उन देशों में जाँच 400 (field: consent, reason: required) के साथ अस्वीकार होती है और उसका शुल्क नहीं लगता। बाकी देशों में consent वैकल्पिक है, और जब आप इसे भेजते हैं तो Didit इसे जाँच के शुल्क के साथ दर्ज करता है। सैंडबॉक्स कुंजी उन्हीं देशों में सहमति माँगती है जिनमें लाइव कुंजी माँगती है।

परिणाम पढ़ें

बिलिंग और पुनः प्रयास

बैंक जिस हर जाँच का जवाब देता है, उस पर परिणाम चाहे जो हो, खाते के देश के खाता जाँच कीमत के अनुसार एक बार शुल्क लिया जाता है। त्रुटि के साथ जवाब मिलने वाला अनुरोध कभी बिल नहीं होता: अस्वीकृत बॉडी (400), क्रेडिट न होना (402), ऐसा खाता जिसकी जाँच अभी उपलब्ध नहीं है (404), या ऐसा बैंक जो जवाब नहीं दे सका (503)। इसमें कोई आइडेम्पोटेंसी कुंजी नहीं है, और जाँच को वापस पढ़ने के लिए कोई endpoint नहीं है। दोबारा भेजा गया अनुरोध नई जाँच चलाता है, नए request_id के साथ, और उसका फिर से शुल्क लगता है, इसलिए रिस्पॉन्स सहेजकर रखें। Didit केवल शुल्क को रिकॉर्ड करता है, साथ में अनुरोध ID, देश, परिणाम और मास्क किया गया खाता। नाम या पूरा खाता नंबर वह कभी नहीं रखता।

सैंडबॉक्स में परखें

सैंडबॉक्स API कुंजी किसी बैंक को कॉल नहीं करती और उससे कोई शुल्क नहीं लगता। IBAN के आखिरी 4 अक्षर, या IBAN न होने पर खाता नंबर के आखिरी 4 अक्षर, तय करते हैं कि जवाब क्या होगा: IBAN, CLABE और CBU में चेक डिजिट होते हैं, इसलिए हर प्रारूप जाँच पास करने वाले सैंडबॉक्स मान इस्तेमाल करें।

पहुँच

अपने एप्लिकेशन की x-api-key से प्रमाणित करें, या उसके क्लाइंट-क्रेडेंशियल्स बेयरर टोकन से। स्कोप्ड API कुंजी को सत्रों पर लिखने की पहुँच चाहिए। यह endpoint हर API कुंजी के लिए लिखने की वही सीमा साझा करता है, यानी प्रति मिनट 300 अनुरोध।

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की 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।

बॉडी

application/json
country
string
आवश्यक

खाते का देश, ISO 3166-1 alpha-3 कोड के रूप में, उदाहरण के लिए NGA। लोअरकेस स्वीकार किया जाता है।

Required string length: 3
उदाहरण:

"NGA"

account
object
आवश्यक

खाता जिस तरह से उसका देश इसे लिखता है: एक iban, या देश के लिए आवश्यक बैंक या शाखा कोड के साथ एक account_number (sort_code, routing_number, transit_institution, bsb, ifsc, bank_code या bic)। मेक्सिको एक clabe और अर्जेंटीना एक cbu_cvu लेता है, जो पहले से ही बैंक का नाम बताते हैं। एक व्यावसायिक खाता वहां एक registration_id जोड़ता है जहां देश इसकी मांग करता है। रिक्त स्थान, डैश और बिंदुओं को अनदेखा किया जाता है। देश की जांच में उपयोग न की जाने वाली कुंजियों को अनदेखा किया जाता है; एक कुंजी जिसकी उसे आवश्यकता है और जो नहीं मिलती है वह एक 400 है जो इसका नाम बताती है।

उदाहरण:
holder
object
आवश्यक

वह नाम जिसके विरुद्ध खाते की जांच की जाती है। full_name और business_name में से ठीक एक भेजें।

vendor_data
string | null

इस जाँच के लिए आपका अपना संदर्भ, बिना किसी बदलाव के वापस किया गया।

उदाहरण:

"payout_20481"

जब खाताधारक ने इस जाँच के लिए स्पष्ट रूप से सहमति दी हो, तो true पर सेट करें। उन देशों में आवश्यक है जहाँ खाता जाँच के लिए उस सहमति की आवश्यकता होती है: इसके बिना जाँच को 400 के साथ अस्वीकार कर दिया जाता है जिसका field consent है और जिसका reason required है, और कुछ भी बिल नहीं किया जाता है। अन्य जगहों पर यह वैकल्पिक है, और जब आप इसे भेजते हैं तो Didit इसे जाँच के शुल्क के साथ रिकॉर्ड करता है।

उदाहरण:

true

प्रतिक्रिया

बैंक ने उत्तर दिया। परिणाम चाहे जो भी हो, जाँच के लिए शुल्क लिया जाता है।

request_id
string<uuid>
आवश्यक

इस जांच की ID।

result
enum<string>
आवश्यक

match: बैंक में खाता आपके द्वारा भेजे गए नाम के तहत है। close_match: मिलते-जुलते नाम के तहत, उदाहरण के लिए छूटा हुआ मध्य नाम या कोई टाइपो। no_match: किसी अन्य नाम के तहत, या ऐसा कोई खाता मौजूद नहीं है। cannot_verify: बैंक ने नाम की तुलना किए बिना उत्तर दिया, उदाहरण के लिए किसी ब्लॉक या बंद खाते के लिए।

उपलब्ध विकल्प:
match,
close_match,
no_match,
cannot_verify
holder_name
string | null
आवश्यक

केवल close_match पर, और केवल तभी जब बैंक ने इसे लौटाया हो: खाते में दर्ज नाम, जैसा कि बैंक के रिकॉर्ड में है। अन्यथा null।

account
string
आवश्यक

खाता, केवल अंतिम 4 वर्ण दिखाते हुए मास्क किया गया।

vendor_data
string | null
आवश्यक

आपका अपना संदर्भ, जैसा आपने भेजा था।

created_at
string<date-time>
आवश्यक

जब जाँच चली थी, UTC में।

अंतिम संशोधन 7 नवंबर 2026