FIU Banks
Introduction
The FIU Banks API returns the list of banks (FIPs — Financial Information Providers) available to your account, along with the Account Aggregators (AAs) through which each bank can be connected. Use this list to render a bank-selection screen to your end user before initiating a consent journey. The fipId values returned here are the same ids you pass as pre-selected banks when starting a journey.
Results are scoped to the Account Aggregators configured for your account
How to call the API
Send Post request to below endpoint with aaIds as input
- Method: POST
- Endpoint: /aa-switch/consent/fiu-banks
- Content-Type: application/json
API Input Guidelines
Need to pass the following information:
- Authorization header — Signzy-API-Key
- Request body — a JSON object. The single field aaids is optional:
- Omit it (or send {}) to receive banks for all Account Aggregators configured on your account.
- Provide a comma-separated list of AA ids to restrict the result to those AAs. Every AA id you pass must be one configured for your account, otherwise the request is rejected.
- Available aaIds list
- Preproduction(UAT)
- onemoney-aa, [email protected], dashboard-aa-preprod, AA00023403, Anumati-UAT, AA00022222
- Production
- onemoney, cookiejaraalive@finvu, saafe, AA00023404, Anumati, AA00022277
Sample Curl
curl --location 'https://api-preproduction.signzy.app/api/v3/aa-switch/consent/fiu-banks' \
--header 'Authorization:<signzy-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"aaids": "[email protected]"
}'Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
|---|---|---|
aaids | Optional | Comma-separated Account Aggregator entity ids (e.g. "[email protected]"). Restricts the returned banks to these AAs. If omitted, banks for all AAs configured on your account are returned. Each id must be an AA configured for your account. |
Sample Response
{
"statusCode": 400,
"message": "AA(s) not configured for this FIU: onemoney-aa",
"errorCode": "AA_NOT_CONFIGURED"
}Response Parameter
PARAMETER NAME | DESCRIPTION |
|---|---|
count | Total number of banks returned in the banks array. |
banks | Array of available banks (FIPs). |
banks[].fipId | Unique identifier of the bank (FIP). Use this value as the pre-selected bank id when starting a consent journey. |
banks[].fipName | name of the FIP/Bank. |
banks[].logoUrl | URL of the bank's logo (may be an empty string if not available). |
banks[].aaIds | List of Account Aggregator ids through which this bank can be connected. |