मुख्य सामग्री पर जाएं
GET
curl
Didit का Get an Institution endpoint एक बैंक को उसकी क्षमताओं और स्थिति के साथ लौटाता है। जो मान कभी देखा नहीं गया, वह null होता है, अनुमान नहीं।

प्राधिकरण

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

आपकी एप्लिकेशन की API कुंजी, जो Business Console में Developers -> API keys से मिलती है। प्राथमिक कुंजी के पास पूर्ण पहुँच होती है। नामित कुंजी को सीमित किया जा सकता है: प्रति संसाधन कोई नहीं, read या write, कुछ वर्कफ़्लो या केवल स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि के साथ। 401 का अर्थ है कि कुंजी गलत, रद्द या समय-सीमा समाप्त है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई, कुंजी को इस संसाधन या कार्रवाई तक पहुँच नहीं है, या अनुरोध उसकी IP सूची के बाहर के पते से आया; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों के बाहर है। मीडिया पहुँच के बिना कुंजी को image, video और PDF URL null मिलते हैं, और sessions write के बिना कुंजी को सत्र लिंक और token null मिलते हैं। देखें https://docs.didit.me/console/api-keys।

पथ पैरामीटर

id
string
आवश्यक

संस्था की आईडी, उदाहरण के लिए es-banco-norte।

प्रतिक्रिया

बैंक।

एक बैंक और वह क्या समर्थन करता है। मान प्रेक्षित क्षमता डेटा से आते हैं, जो हर दिन ताज़ा होता है। जो मान कभी प्रेक्षित नहीं हुआ, वह अनुमान नहीं बल्कि null होता है।

id
string
आवश्यक

Didit द्वारा बैंक का पहचानकर्ता, एक स्थिर slug।

उदाहरण:

"es-banco-norte"

name
string
आवश्यक
country
string
आवश्यक
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
आवश्यक
timezone
string | null
आवश्यक

IANA समय क्षेत्र, जिसमें बैंक की तिथियाँ हैं।

segments
enum<string>[]
आवश्यक
उपलब्ध विकल्प:
personal,
business
access
enum<string>[]
आवश्यक

ongoing केवल वहीं सूचीबद्ध होता है जहाँ बैंक के लिए ongoing पहुँच चालू है।

उपलब्ध विकल्प:
one_time,
ongoing
ongoing_access
boolean
आवश्यक

यह कि इस बैंक पर निरंतर पहुँच उपलब्ध है या नहीं।

बैंक द्वारा अनुमत सबसे लंबी सहमति, दिनों में। नहीं देखी गई हो तो null।

history_days_max
integer | null
आवश्यक

बैंक द्वारा दिया जाने वाला सबसे गहरा इतिहास, दिनों में। नहीं देखा गया हो तो null।

pending_transactions
boolean | null
आवश्यक

यह कि बैंक लंबित लेन-देन रिपोर्ट करता है या नहीं।

pending_linkage
boolean | null
आवश्यक

यह कि बैंक लंबित लेन-देन को उसके बुक किए गए लेन-देन से जोड़ता है या नहीं, जिससे pending_id सेट होता है।

balance_types
enum<string>[]
आवश्यक
उपलब्ध विकल्प:
booked,
available,
expected
transaction_fields
string[]
आवश्यक

वे लेन-देन फ़ील्ड जो बैंक के भेजने के लिए जाने जाते हैं। बाकी हर फ़ील्ड null है।

sign_in
enum<string> | null
आवश्यक

व्यक्ति बैंक में कैसे साइन इन करता है।

उपलब्ध विकल्प:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
आवश्यक

यह कि Bank Link को व्यक्ति के लिए सत्यापित ईमेल पता चाहिए या नहीं।

corporate_accounts
boolean | null
आवश्यक

यह कि व्यवसाय खाते सपोर्टेड हैं या नहीं।

bank_account_selection
boolean | null
आवश्यक

यह कि व्यक्ति Bank Link में नहीं, बल्कि बैंक में खाते चुनता है या नहीं।

यह कि बैंक पुराना इतिहास जारी करने के लिए एक और पुष्टि माँगता है या नहीं।

reconfirmation
boolean | null
आवश्यक

यह कि नवीनीकरण की पुष्टि बैंक साइन-इन के बिना Didit की स्क्रीन पर फिर से की जा सकती है या नहीं।

sync_frequency_hours
integer | null
आवश्यक

जहाँ बैंक तेज़ आवृत्ति की अनुमति देता है, वहाँ स्वचालित सिंक के बीच के घंटे। null का अर्थ दैनिक डिफ़ॉल्ट है।

health
enum<string>
आवश्यक
उपलब्ध विकल्प:
operational,
degraded,
down
अंतिम संशोधन 22 नवंबर 2026