> ## 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 प्राप्त करें: एक संस्थान और उसकी क्षमताएँ

> Didit का Get an Institution endpoint एक बैंक को उसकी क्षमताओं और स्थिति के साथ लौटाता है।

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


## OpenAPI

````yaml hi/openapi-25.json GET /v3/bank/institutions/{id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: पहचान सत्यापन API। x-api-key हेडर से प्रमाणित करें।
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, कनेक्शन, खाते, बैलेंस, लेन-देन, संस्थान और कवरेज। बैंक डेटा
      सैंडबॉक्स एप्लिकेशन के लिए उपलब्ध है। किसी लाइव एप्लिकेशन की कॉल तब तक
      `404` लौटाती हैं जब तक लाइव पहुँच की घोषणा नहीं होती। सैंडबॉक्स में कोई
      शुल्क नहीं लिया जाता। API कुंजी से की गई कॉल के लिए ऐसी कुंजी चाहिए जिसमें
      बैंक डेटा अनुमति (`bank-data`) हो: पढ़ने के लिए read, और कुछ बदलने वाली
      संक्रियाओं के लिए write। खाता जाँच अपवाद है: इसके लिए सत्रों के लिए write
      पहुँच, या पूर्ण पहुँच चाहिए, बैंक डेटा अनुमति नहीं। बैंक डेटा पूर्ण पहुँच
      में शामिल नहीं है: पूर्ण पहुँच वाली कुंजी अस्वीकार की जाती है, और कॉल `403
      bank_data_access_denied` लौटाती है, जब तक आप ऐसी कुंजी नहीं बनाते जिसमें
      यह अनुमति हो। कच्चा बैंक डेटा (खाते, बैलेंस, लेन-देन और बदलाव फ़ीड) भी ऐसे
      अनुरोध को अस्वीकार करता है जिसमें API कुंजी न हो।


      `/v3/bank/` के अंतर्गत खाता जाँच के अलावा हर अस्वीकृति का एक ही JSON बॉडी
      होती है (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`)। ऐसा पथ जो कोई संक्रिया नहीं है, ऐसा ID जो UUID नहीं है, या
      कोई अज्ञात उप-संसाधन हर मेथड के लिए `404 not_found` लौटाता है, और कोई भी
      अनपेक्षित त्रुटि `request_id` के साथ `500 internal_error` लौटाती है। जहाँ
      बैंक डेटा उपलब्ध नहीं है, वहाँ हर संक्रिया प्लेटफ़ॉर्म का मानक `404`
      लौटाती है, ठीक वैसे ही जैसे कोई अज्ञात रूट लौटाता है।
paths:
  /v3/bank/institutions/{id}/:
    get:
      tags:
        - Bank Data
      summary: संस्था प्राप्त करें
      description: >-
        एक बैंक को उसकी क्षमताओं के साथ लौटाता है। id Didit का स्लग है, जैसा
        `list_institutions` में सूचीबद्ध है।


        इसके लिए बैंक डेटा अनुमति (`bank-data`) वाली API कुंजी चाहिए: इस ऑपरेशन
        के लिए read। पूर्ण पहुँच वाली कुंजी में यह अनुमति शामिल नहीं होती: कुंजी
        बनाते समय इसे स्पष्ट रूप से दें, नहीं तो कॉल `403
        bank_data_access_denied` का जवाब देगी।
      operationId: getBankInstitution
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: संस्था की आईडी, उदाहरण के लिए `es-banco-norte`।
      responses:
        '200':
          description: बैंक।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitution'
              examples:
                Spanish bank:
                  summary: एक स्पेनिश बैंक जो लगातार पहुँच की सुविधा देता है
                  value:
                    id: es-banco-norte
                    name: Banco Norte
                    country: ESP
                    logo_url: https://static.example.com/banks/es-banco-norte.png
                    timezone: Europe/Madrid
                    segments:
                      - personal
                      - business
                    access:
                      - one_time
                      - ongoing
                    ongoing_access: true
                    consent_days_max: 180
                    history_days_max: 365
                    pending_transactions: true
                    pending_linkage: false
                    balance_types:
                      - booked
                      - available
                    transaction_fields:
                      - value_date
                      - counterparty_name
                      - counterparty_iban
                      - remittance
                      - bank_transaction_code
                      - bank_reference
                      - balance_after
                    sign_in: redirect
                    requires_end_user_email: true
                    corporate_accounts: true
                    bank_account_selection: false
                    separate_history_consent: false
                    reconfirmation: false
                    sync_frequency_hours: null
                    health: operational
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: यह संसाधन इस एप्लिकेशन और एनवायरनमेंट में मौजूद नहीं है।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: नहीं मिला
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/institutions/es-banco-norte/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_institution(
                "your-id",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.bank.getInstitution("your-id");
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetInstitution(ctx, \"your-id\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.bank().getInstitution("your-id");
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->bank->getInstitution('your-id');
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.get_institution("your-id")
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.Bank.GetInstitutionAsync("your-id");
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankInstitution:
      type: object
      description: >-
        एक बैंक और वह क्या समर्थन करता है। मान प्रेक्षित क्षमता डेटा से आते हैं,
        जो हर दिन ताज़ा होता है। जो मान कभी प्रेक्षित नहीं हुआ, वह अनुमान नहीं
        बल्कि `null` होता है।
      properties:
        id:
          type: string
          description: Didit द्वारा बैंक का पहचानकर्ता, एक स्थिर slug।
          example: es-banco-norte
        name:
          type: string
        country:
          type: string
          pattern: ^[A-Z]{3}$
        logo_url:
          type: string
          format: uri
          nullable: true
        timezone:
          type: string
          description: IANA समय क्षेत्र, जिसमें बैंक की तिथियाँ हैं।
          nullable: true
        segments:
          type: array
          items:
            type: string
            enum:
              - personal
              - business
        access:
          type: array
          items:
            type: string
            enum:
              - one_time
              - ongoing
          description: >-
            `ongoing` केवल वहीं सूचीबद्ध होता है जहाँ बैंक के लिए ongoing पहुँच
            चालू है।
        ongoing_access:
          type: boolean
          description: यह कि इस बैंक पर निरंतर पहुँच उपलब्ध है या नहीं।
        consent_days_max:
          type: integer
          description: >-
            बैंक द्वारा अनुमत सबसे लंबी सहमति, दिनों में। नहीं देखी गई हो तो
            `null`।
          nullable: true
        history_days_max:
          type: integer
          description: >-
            बैंक द्वारा दिया जाने वाला सबसे गहरा इतिहास, दिनों में। नहीं देखा
            गया हो तो `null`।
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: यह कि बैंक लंबित लेन-देन रिपोर्ट करता है या नहीं।
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            यह कि बैंक लंबित लेन-देन को उसके बुक किए गए लेन-देन से जोड़ता है या
            नहीं, जिससे `pending_id` सेट होता है।
        balance_types:
          type: array
          items:
            type: string
            enum:
              - booked
              - available
              - expected
        transaction_fields:
          type: array
          items:
            type: string
          description: >-
            वे लेन-देन फ़ील्ड जो बैंक के भेजने के लिए जाने जाते हैं। बाकी हर
            फ़ील्ड `null` है।
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: व्यक्ति बैंक में कैसे साइन इन करता है।
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: यह कि Bank Link को व्यक्ति के लिए सत्यापित ईमेल पता चाहिए या नहीं।
        corporate_accounts:
          type: boolean
          nullable: true
          description: यह कि व्यवसाय खाते सपोर्टेड हैं या नहीं।
        bank_account_selection:
          type: boolean
          nullable: true
          description: >-
            यह कि व्यक्ति Bank Link में नहीं, बल्कि बैंक में खाते चुनता है या
            नहीं।
        separate_history_consent:
          type: boolean
          nullable: true
          description: >-
            यह कि बैंक पुराना इतिहास जारी करने के लिए एक और पुष्टि माँगता है या
            नहीं।
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            यह कि नवीनीकरण की पुष्टि बैंक साइन-इन के बिना Didit की स्क्रीन पर
            फिर से की जा सकती है या नहीं।
        sync_frequency_hours:
          type: integer
          description: >-
            जहाँ बैंक तेज़ आवृत्ति की अनुमति देता है, वहाँ स्वचालित सिंक के बीच
            के घंटे। `null` का अर्थ दैनिक डिफ़ॉल्ट है।
          nullable: true
        health:
          type: string
          enum:
            - operational
            - degraded
            - down
      required:
        - id
        - name
        - country
        - logo_url
        - timezone
        - segments
        - access
        - ongoing_access
        - consent_days_max
        - history_days_max
        - pending_transactions
        - pending_linkage
        - balance_types
        - transaction_fields
        - sign_in
        - requires_end_user_email
        - corporate_accounts
        - bank_account_selection
        - separate_history_consent
        - reconfirmation
        - sync_frequency_hours
        - health
    BankDataError:
      type: object
      description: Bank data के हर ऑपरेशन का एरर बॉडी। हर फ़ील्ड हमेशा मौजूद रहता है।
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            मशीन-पठनीय त्रुटि कोड। शर्त इसी के आधार पर लिखें, कभी `message` के
            आधार पर नहीं।
        message:
          type: string
          description: >-
            डेवलपर के लिए सरल भाषा में स्पष्टीकरण। शब्द बदल सकते हैं; इसे पार्स
            न करें।
        request_id:
          type: string
          description: इस अनुरोध का पहचानकर्ता। सहायता से संपर्क करते समय इसे उद्धृत करें।
        field:
          type: string
          description: >-
            वह अनुरोध फ़ील्ड जिसे सुधारना है, जब त्रुटि किसी एक फ़ील्ड के बारे
            में हो। अन्यथा `null`।
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            आगे क्या करना है, ताकि क्लाइंट अनुमान लगाए बिना कार्रवाई कर सके। कोई
            मानक अगला चरण न होने पर `null`।
          nullable: true
        retry_after:
          type: integer
          description: >-
            पुनः प्रयास करने से पहले प्रतीक्षा के सेकंड। रेट लिमिट और अस्थायी
            त्रुटियों पर सेट होता है, अन्यथा `null`।
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    RateLimitBudgetError:
      type: object
      description: >-
        यह केवल रेट-लिमिट मिडलवेयर बजट अस्वीकृति के लिए लौटाया जाता है। अन्य 429
        त्रुटियाँ, जिनमें आइडेम्पोटेंसी टकराव और endpoint-विशिष्ट सीमाएँ शामिल
        हैं, इन मेटाडेटा फ़ील्ड्स की गारंटी नहीं देतीं।
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: मौजूदा मानव-पठनीय बजट अस्वीकृति संदेश।
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            अपारदर्शी सहायता संदर्भ: RL- के बाद 32 लोअरकेस UUID हेक्साडेसिमल
            अक्षर।
        limit:
          type: integer
          description: सीमा से अधिक हुए दायरे का बजट; यह X-RateLimit-Limit के बराबर है।
        remaining:
          type: integer
          minimum: 0
          description: शेष बजट, शून्य पर सीमित; X-RateLimit-Remaining के बराबर।
        reset:
          type: integer
          format: int64
          description: >-
            विंडो रीसेट का समय Unix सेकंड में; यह X-RateLimit-Reset के बराबर
            होता है।
        window_seconds:
          type: integer
          description: >-
            फ़िक्स्ड-विंडो की अवधि सेकंड में, शेष प्रतीक्षा समय नहीं। दोबारा
            प्रयास करने से पहले Retry-After का पालन करें।
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
  responses:
    Unauthorized:
      description: अनधिकृत
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: अमान्य API कुंजी
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        API कुंजी में Bank data अनुमति (`bank-data`) नहीं है, या, लाइव एप्लिकेशन
        में कच्चे बैंक डेटा के लिए, एप्लिकेशन सेटिंग "Bank data in the API" बंद
        है। Bank data पूर्ण एक्सेस का हिस्सा नहीं है: पूर्ण एक्सेस वाली कुंजी,
        केवल अन्य संसाधनों तक सीमित कुंजी, और API कुंजी के बिना (client
        credentials से, कच्चे डेटा पर) प्रमाणित अनुरोध, सभी को इसी बॉडी के साथ
        मना किया जाता है, इसलिए कुंजी बनाएँ और उसे स्पष्ट रूप से अनुमति दें। यह
        इनकार किसी भी लुकअप से पहले होता है, इसलिए यह नहीं बताता कि ऑब्जेक्ट
        मौजूद है या नहीं।
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: बैंक डेटा की अनुमति नहीं है
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        मिडलवेयर रीड बजट पार हो गया है। पुनः प्रयास करने से पहले Retry-After का
        पालन करें।
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Didit की ओर से कुछ गड़बड़ हुई है। `/v3/bank/` के तहत कोई भी अप्रत्याशित
        त्रुटि बैंक त्रुटि संरचना में उत्तर देती है, कभी HTML पेज में नहीं:
        सहायता टीम को `request_id` बताएँ।
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: एक अनपेक्षित त्रुटि
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        प्रतीक्षा के सेकंड, जिन्हें अगली विंडो तक ऊपर की ओर राउंड किया गया है।
        मिडलवेयर बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: वह दायरा जिसका बजट पार हुआ। मिडलवेयर बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        सीमा से अधिक हुए दायरे का बजट; यह बॉडी लिमिट के बराबर है। यह middleware
        बजट अस्वीकृतियों में मौजूद होता है।
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        शेष बजट, शून्य पर सीमित; body remaining के बराबर। मिडलवेयर बजट
        अस्वीकृतियों पर मौजूद।
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        रीसेट का समय Unix सेकंड में; यह बॉडी के reset के बराबर होता है। मिडलवेयर
        बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की 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।

````

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