Get All FI Data

​

Overview

​

Key Use Cases

• Complete Data Retrieval: Download all available financial data linked to a given consent in a structured JSON format.
• Transaction Filtering: Optionally filter transactions by specifying a custom date range to retrieve only relevant transaction data.
• Multi-Account Support: Retrieve data for all accounts linked to a consent in a single API call.
• All FI Types: Supports various financial information types including Deposit accounts, Mutual Funds, Equities, Insurance, and more.

​

Important Notes

• Data will only be returned if it is available in FinPro. You must first successfully complete the FI Request and ensure the status shows DATA_READY before calling this API.
• The requested data must align with the parameters and scope specified in the approved consent.
• If you need data in PDF format instead of JSON, use the Get All FI Data PDF API.
• For periodic/recurring consents, this API returns cumulative data. To get only incremental data since the last fetch, use the Get All Latest FI Data API instead.

​

Authentication

​

Query Parameters

​

Request Body

​

Request Example

{
  "consentID": "84001bb6-b1d0-4443-aeff-dd482255a058"
}

​

Request Example with Transaction Date Filtering

{
  "consentID": "84001bb6-b1d0-4443-aeff-dd482255a058",
  "transactionsStartDate": "2023-01-01T00:00:00Z",
  "transactionsEndDate": "2023-01-31T23:59:59Z"
}

​

Response Parameters

​

Success Response Example

{
  "ver": "1.0",
  "status": "success",
  "data": [
    {
      "linkReferenceNumber": "e72534d6-0016-4f0e-9da5-3e05ad405394",
      "maskedAccountNumber": "XXXXXXXX3900",
      "fiType": "DEPOSIT",
      "bank": "FinShareBankServer",
      "transactions": [
        {
          "type": "CREDIT",
          "mode": "UPI",
          "amount": "5000.00",
          "currentBalance": "45000.00",
          "transactionTimestamp": "2023-01-15T10:30:00.000Z",
          "valueDate": "2023-01-15",
          "txnId": "UPI123456789",
          "narration": "Payment received from XYZ",
          "reference": "REF123456"
        }
      ],
      "balance": {
        "amount": "45000.00",
        "currency": "INR"
      },
      "profile": {
        "accountType": "SAVINGS",
        "accountNumber": "1234567890"
      },
      "holder": {
        "name": "John Doe",
        "pan": "ABCDE1234F",
        "mobile": "9876543210"
      },
      "summary": {
        "currentBalance": "45000.00",
        "type": "SAVINGS",
        "ifscCode": "HDFC0001234",
        "status": "ACTIVE"
      }
    }
  ]
}

​

Error Responses

​

Invalid Consent ID

{
  "ver": "1.21.0",
  "timestamp": "2025-10-01T11:49:28.920Z",
  "errorCode": "InvalidConsentId",
  "errorMsg": "Consent ID does not exist."
}

​

Error Code Catalogue

​

Rate Limiting

• Rate Limit: 1000 requests per time window
• Headers Returned:
  • X-RateLimit-Limit: Maximum number of requests allowed
  • X-RateLimit-Remaining: Number of requests remaining in current window
  • X-RateLimit-Reset: Unix timestamp when the rate limit resets

​

Supported FI Types

• Banking: DEPOSIT, TERM_DEPOSIT, TERM-DEPOSIT, RECURRING_DEPOSIT
• Investments: MUTUAL_FUNDS, EQUITIES, BONDS, DEBENTURES, ETF, SIP
• Government Securities: GOVT_SECURITIES, CP
• Insurance: INSURANCE_POLICIES, LIFE_INSURANCE, GENERAL_INSURANCE
• Pension: NPS
• Alternative Investments: AIF, INVIT, REIT, IDR, CIS
• Tax/GST: GSTR1_3B
• Others: OTHER

​

Usage Flow

1. Verify Data Readiness: Before calling this API, use the FI Request Status API to ensure the eventStatus is DATA_READY.
2. Retrieve Data: Call this API with the consentID to retrieve all financial information associated with the consent.
3. Optional Filtering: If you only need transactions for a specific period, include the transactionsStartDate and transactionsEndDate parameters.
4. Process Response: Parse the JSON response to extract account information, transaction details, balances, and other financial data for your application’s use case.
5. Handle Multiple Accounts: The response contains an array of account objects. Process each account separately as they may have different FI types and data structures.
6. Data Expiry Awareness: Note that the fetched data has a limited lifetime based on the consent’s data life parameter. Plan to re-fetch data before it expires if needed.

​

Best Practices

• Status Check First: Always verify that data is ready using the FI Request Status API before attempting to retrieve it. Calling this API when data is not ready will result in a NoDataAvailable error.
• Transaction Filtering: When you only need recent transactions, use the transactionsStartDate and transactionsEndDate parameters to reduce payload size and improve performance.
• Handle Different FI Types: Different FI types have different data structures. Implement flexible parsing logic to handle various FI type schemas as per ReBIT specifications.
• Error Handling: Implement comprehensive error handling for all error codes, especially:
  • NoDataAvailable: Indicates you need to wait longer or initiate an FI request
  • DataIsDeleted: Indicates data has expired and you need to fetch fresh data
  • InvalidConsentId: Indicates the consent may be invalid, expired, or revoked
• Data Persistence: Store the retrieved financial data in your system with appropriate security measures. Do not rely on fetching data repeatedly as it may be deleted after the data life period.
• Pagination: For consents with large amounts of data, use the limit and offset query parameters to implement pagination and avoid timeout issues.
• Schema Validation: Validate the received data against the ReBIT FI Schema to ensure data integrity before processing.
• Consent Scope: Ensure you only request and process data that falls within the scope approved by the user in the consent.
• Security: Always transmit and store financial data securely. Use HTTPS for API calls and encrypt data at rest in your systems.