Skip to main content
GET
/
list
/
fips
FIP List
curl --request GET \
  --url https://api.example.com/list/fips

​
Overview

The FIP List API provides access to a comprehensive directory of all Financial Information Providers (FIPs) that are currently operational in the Account Aggregator ecosystem. Financial Information Providers are the entities—such as banks, mutual fund companies, insurance providers, and depositories—that hold customer financial data and make it available through Account Aggregators when customers provide consent. This API is valuable when you need to:
  • Display available financial institutions to customers during the consent journey, helping them identify which FIPs they may have accounts with
  • Implement FIP-specific consent flows where customers can pre-select the financial institutions they want to share data from
  • Build discovery interfaces that allow customers to search for and identify their financial service providers
  • Retrieve FIP branding assets such as logos to create visually rich user experiences in your consent and data management interfaces
  • Validate FIP IDs before passing them to consent creation APIs that support FIP-specific discovery parameters
  • Understand which types of financial information each FIP supports to guide customers toward relevant institutions

​
Authentication

This API requires organization-level authentication credentials to be passed in the request headers. All credentials should be provisioned through the FinPro admin portal.

​
Required Headers

HeaderTypeDescription
Content-TypestringMust be set to application/json for proper request processing
client_idstringThe unique client identifier assigned to your FIU organization during onboarding
client_secretstringThe secret key paired with your client_id for secure authentication
organisationIdstringYour organization’s unique identifier in the FinPro system
appIdentifierstringThe application identifier that distinguishes different applications within your organization

​
Request

​
Endpoint

GET {{Base_URL}}/list/fips

​
Request Parameters

This API uses the HTTP GET method and does not require any query parameters or request body. The complete list of all active FIPs in the Account Aggregator ecosystem is returned.

​
Response

​
Success Response (200 OK)

When the request is successfully processed, the API returns detailed information about all Financial Information Providers that are registered and operational in the Sahamati Central Registry and integrated with the Account Aggregator ecosystem.

​
Response Fields

FieldTypeDescription
verstringThe version of the FinPro API that processed the request
statusstringThe outcome of the API call. Possible values: success, failure
data.fip_newlistarrayAn array of FIP objects containing details about each Financial Information Provider
data.fip_newlist[].fipIdstringThe unique identifier of the FIP as registered in the Sahamati Central Registry. This identifier is used in consent creation APIs and FIP-specific discovery flows.
data.fip_newlist[].fipNamestringThe human-readable name of the Financial Information Provider as it appears in the Central Registry and should be displayed to customers
data.fip_newlist[].logoURLstringThe URL of the FIP’s official logo image, which can be displayed in your application’s UI to help customers visually identify their financial institutions. Note: This field may be empty for some FIPs if logo resources are not available.
data.fip_newlist[].FiTypesarrayAn array of strings listing all the types of Financial Information schemas that this FIP supports and can provide through the Account Aggregator framework

​
Response Example

{
  "ver": "1.21.0",
  "status": "success",
  "data": {
    "fip_newlist": [
      {
        "fipId": "HDFC-FIP",
        "fipName": "HDFC Bank",
        "logoURL": "",
        "FiTypes": ["DEPOSIT"]
      },
      {
        "fipId": "ICICI-FIP",
        "fipName": "ICICI Bank",
        "logoURL": "",
        "FiTypes": ["DEPOSIT"]
      },
      {
        "fipId": "finsharebank",
        "fipName": "FinShareBankServer",
        "logoURL": "",
        "FiTypes": [
          "DEPOSIT",
          "RECURRING_DEPOSIT",
          "GSTR1_3B",
          "MUTUAL_FUNDS",
          "EQUITIES",
          "NPS",
          "TERM_DEPOSIT",
          "INSURANCE_POLICIES",
          "LIFE_INSURANCE",
          "GENERAL_INSURANCE"
        ]
      },
      {
        "fipId": "sbi-fip-uat",
        "fipName": "STATE BANK OF INDIA",
        "logoURL": "",
        "FiTypes": [
          "DEPOSIT",
          "TERM_DEPOSIT",
          "RECURRING_DEPOSIT"
        ]
      },
      {
        "fipId": "AXIS001",
        "fipName": "Axis Bank",
        "logoURL": "",
        "FiTypes": [
          "DEPOSIT",
          "RECURRING_DEPOSIT",
          "TERM-DEPOSIT"
        ]
      },
      {
        "fipId": "Cams RTA_uat",
        "fipName": "Cams RTA_uat",
        "logoURL": "",
        "FiTypes": [
          "SIP",
          "MUTUAL_FUNDS"
        ]
      },
      {
        "fipId": "balic-fip",
        "fipName": "Bajaj Allianz Life Insurance",
        "logoURL": "",
        "FiTypes": [
          "INSURANCE_POLICIES",
          "ULIP"
        ]
      }
    ]
  }
}

​
Error Responses

​
Authentication Errors

Authentication errors are returned with appropriate HTTP status codes and error details in the response body.

​
401 Unauthorized - Invalid Credentials

Returned when the authentication headers are missing, malformed, or do not match registered credentials. Common causes:
  • One or more required headers (client_id, client_secret, organisationId, appIdentifier) are missing from the request
  • The header values contain typos or incorrect credential information
  • The credentials have expired or been rotated in the FinPro admin portal without updating your application
  • Using UAT credentials against a production endpoint or vice versa
Resolution:
  • Verify all required headers are included in the GET request
  • Cross-check header values against credentials provided in your FinPro admin portal
  • Ensure you are using credentials from the correct environment (UAT vs Production)
  • If credentials were recently rotated, update your application configuration with the new values

​
Usage Notes

​
Understanding FI Types

The FiTypes array indicates which categories of financial information each FIP can provide. Common FI types include: Banking Products:
  • DEPOSIT - Savings and current accounts
  • TERM_DEPOSIT or TERM-DEPOSIT - Fixed deposits and term deposit accounts
  • RECURRING_DEPOSIT - Recurring deposit accounts
  • CREDIT_CARD - Credit card accounts and transactions
  • CD - Certificate of Deposit
  • EPF - Employees’ Provident Fund
  • PPF - Public Provident Fund
Investment Products:
  • MUTUAL_FUNDS - Mutual fund holdings and transactions
  • SIP - Systematic Investment Plans
  • EQUITIES - Equity holdings in demat accounts
  • BONDS - Bond holdings
  • DEBENTURES - Debenture holdings
  • ETF - Exchange Traded Funds
  • GOVT_SECURITIES - Government securities
  • CP - Commercial Paper
  • IDR - Indian Depository Receipts
  • CIS - Collective Investment Schemes
  • AIF - Alternative Investment Funds
  • INVIT - Infrastructure Investment Trusts
  • REIT - Real Estate Investment Trusts
Insurance Products:
  • INSURANCE_POLICIES - General insurance policies
  • LIFE_INSURANCE - Life insurance policies
  • GENERAL_INSURANCE - General insurance (health, motor, etc.)
  • ULIP - Unit Linked Insurance Plans
Retirement Accounts:
  • NPS - National Pension System accounts
Tax and Compliance:
  • GST - GST registration and compliance data
  • GST_GSTR1 - GST Return Form GSTR1
  • GST_GSTR2A - GST Return Form GSTR2A
  • GST_GSTR3B - GST Return Form GSTR3B
  • GSTR1_3B - Combined GST returns
Other:
  • OTHER - Custom or future FI types not yet categorized

​
FIP Selection Strategies

There are several ways to leverage the FIP list in your application:
  1. Comprehensive discovery: Allow the Account Aggregator to perform discovery across all FIPs that support the FI types in your consent template. This provides the broadest coverage but may take longer.
  2. Guided selection: Display the FIP list to customers and let them pre-select which financial institutions they have accounts with. This reduces discovery time and improves the user experience by focusing on relevant FIPs.
  3. Category-based filtering: Filter the FIP list based on the FI types you need (e.g., only show banks for a loan application, or only show mutual fund RTAs for investment advisory).
  4. Smart suggestions: Use the customer’s profile, location, or historical data to suggest likely FIPs they may have relationships with.

​
Handling Large FIP Lists

The Account Aggregator ecosystem includes hundreds of Financial Information Providers across various categories. To manage this effectively:
  • Implement search functionality: Allow customers to search for FIPs by name or category rather than scrolling through long lists
  • Categorize by FI type: Group FIPs by the types of accounts they offer (banks, insurance, investments, etc.)
  • Popular FIPs first: Consider prioritizing large or commonly used FIPs at the top of selection interfaces
  • Lazy loading: Load FIP details and logos progressively as customers scroll, rather than loading everything upfront
  • Caching: Cache the FIP list locally with a reasonable refresh interval (e.g., daily) since the list doesn’t change frequently

​
Logo Display Considerations

The logoURL field provides access to FIP branding assets:
  • Null or empty logos: Many FIPs may not have logo URLs available in the response. Always implement fallback displays such as the FIP name in text or a generic institution icon.
  • Logo caching: Cache downloaded logos locally to improve performance and reduce dependency on external resources
  • Responsive sizing: Ensure logos are displayed at appropriate sizes for different device form factors and UI contexts
  • Loading states: Implement loading indicators while logos are being fetched from remote URLs
  • Error handling: Gracefully handle cases where logo URLs are invalid, return errors, or fail to load

​
UAT vs Production FIP Lists

The list of FIPs available in UAT (sandbox) environments may differ from production:
  • Test FIPs: UAT environments often include test or dummy FIPs (e.g., “finsharebank”, “Fime India”) that are used for integration testing but are not real financial institutions
  • Production FIPs: Production environments contain only live, operational FIPs that customers can actually use
  • FIP naming: The same financial institution may have different FIP IDs in UAT and production (e.g., “sbi-fip-uat” in UAT vs “SBI-FIP” in production)
Always test with UAT FIPs during development and switch to production FIPs only when deploying to live environments.

​
Caching and Refresh Strategy

The FIP list is relatively stable but does change as new financial institutions join the Account Aggregator ecosystem or existing ones update their supported FI types:
  • Cache duration: Cache the FIP list for 24-48 hours to balance freshness with performance
  • Refresh triggers: Implement a manual refresh mechanism for administrators or when the application starts
  • Version tracking: Store the API version returned with each FIP list response to detect when updates occur
  • Incremental updates: If supported in future versions, consider implementing incremental update mechanisms rather than always fetching the complete list

​
Rate Limiting

This API is subject to rate limiting controls to ensure fair usage across all FIU organizations:
  • Rate limit headers are included in every response to help you track your usage
  • X-RateLimit-Limit: The maximum number of requests allowed in the time window
  • X-RateLimit-Remaining: The number of requests remaining in the current window
  • X-RateLimit-Reset: The Unix timestamp when the rate limit window resets
If you exceed the rate limit, subsequent requests will receive a 429 (Too Many Requests) response until the window resets.