—
–
/

to search

Reading time — 5 minutes

Edit this page ↗

#Get Active FIPs

The GET Active FIP List API is the new version of our API to call the list of Active FIPs from which your customers can discover accounts, and consent to share data. The Active FIP List API works in a manner that

  • Dynamically activates and deactivates FIPs based on performance.
  • Can be used to simply check the status of FIPs that are active or inactive on the ecosystem.
  • Can be used by FIUs as a mode of selection of FIPs/providers where a user has an account.

#Details Shared in the FIP List API

Below is the parameters shared in the FIP List API that gives you each of the relevant details of the FIPs. These key details can be used by you for purposes like - offering a list of FIPs for your end-users to select or routing users to the Setu AA flow based on whether an FIP is active or not.

StatusDescription
NameThe name of the FIP - this is typically their brand name in camel case format.
FIP IDThe unique identifier for the FIP in the central registry of participants maintained by Sahamati. This can be used in Context filters if you want auto-discovery or to only discover accounts from a particular institution. This is also the ID that is available in the logs of data fetch transactions.
FIP TYPESThis refers to the type of data available via the FIP. For example, an FIP with FIP_Types “DEPOSITS “ will have Savings or Current Accounts available and be able to share bank statements upon user consent
StatusThe Status field gives you the up-to-date status of the FIP. This will determine whether the FIP’s accounts can be discovered and whether data can be fetched from this FIP. More details on the statuses in the next section.

#Categories of FIP Status

Below is the list of statuses for FIPs that you will see in a typical GET FIP List response.

StatusDescription
ACTIVEIs an available FIP for account discovery, account linking, consent and data fetches
INACTIVEThis is an unavailable FIP. If you are using this to route customers to AA — please route your customers to alternate methods of data collection.
TEMPORARILY_INACTIVEThis is an FIP that has been disabled for breaching SLIs on performance. If you are using this to route customers to AA — please route your customers to alternate methods of data collection. However, this is a temporary status and will be moved to ACTIVE status once their performance has improved. Do not redirect your customers to the consent flow when an FIP status is INACTIVE or TEMPORARILY_INACTIVE as that will mean their consents and/or data fetches are likely to fail.

#FIP List API

Request
 GET /v2/fips
Response
{
    "data": [
        {
            "name": "Axis Bank",
            "fipId": "AXIS001",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "ACTIVE"
        },
        {
            "name": "Federal Bank",
            "fipId": "FDRLFIP",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "ACTIVE"
        },
        {
            "name": "IndusInd Bank Ltd.",
            "fipId": "fiplive@indusind",
            "fiTypes": [
                "DEPOSIT",
                "TERM_DEPOSIT",
                "RECURRING_DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "TEMPORARILY_INACTIVE"
        },
        {
            "name": "HDFC Bank",
            "fipId": "HDFC-FIP",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "INACTIVE"
        }
   ],
   "traceId": "1-64313583-255e3a0705424652664584b2"
}
}

#Get FIP by ID API

Request
 GET /v2/fips/:id
Response
{
    "data": [
        {
            "name": "HDFC Bank",
            "fipId": "HDFC-FIP",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "INACTIVE"
        }
    ],
    "traceId": "1-66ff79c7-46029a1f1aaa59083489fd46"
}

#Get FIPs by Status API

Request
 GET /v2/fips?status=ACTIVE
Response
{
    "data": [
        {
            "name": "Axis Bank",
            "fipId": "AXIS001",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "ACTIVE"
        },
        {
            "name": "Federal Bank",
            "fipId": "FDRLFIP",
            "fiTypes": [
                "DEPOSIT"
            ],
            "institutionType": "BANK",
            "status": "ACTIVE"
        }
    ],
    "traceId": "1-64313583-255e3a0705424652664584b2"
}
Using Get FIP List for routing end-users to AA Flows

FIUs can use the FIP List API to route their end users to the AA flow or non-AA flows (Like PDF uploads, net banking integrations or alternative data collection modes)if the FIP is temporarily deactivated if the provider is not part of the list of active FIPs. How can you as an FIU route your users and select FIPs (providers where your end-user had accounts) ? We offer two modes of account discovery.

The two methods are as follows.

  • Standard User Selection of FIPs: Here it is used to offer FIP (Bank, insurers, securities providers, etc) selection when a customer begins a consent flow from Setu

  • Custom routing an FIP selection: FIUs can use the API to have FIP selection on their own page OR “Pre-select” FIPs (a maximum of 6 FIPs can be selected in this method)and auto-discover accounts by passing FIP ID in the context parameter on the Create consent API.

Was this page helpful?