#Account Aggregator

Account aggregators(AAs) are regulated entities that facilitate consented sharing of financial data by utilising the DEPA framework. They act as the bridge between data providers such as banks, and data consumers such as lenders—to enable the sharing of a user’s financial data based on their explicit consent. Website Name currently provides AA-related services in close partnership with a fully-licensed AA.

For example, let’s say a lender wants to check the bank statements of a user to check their loan eligibility. Here’s how the AA handles it—

1. The lender makes a data consent request, which is routed to the AA.
2. The user receives a notification through the AA that the lender wants to access 3 months' bank statements.
3. The user can decide to approve or reject the consent request.
4. If they approve the request, the data is fetched from the FIP—in this case, the bank—and shared with the lender.

The consent request carries details about the type of data, how long the FIU needs it for, and how they plan to use it. The user can take into consideration all of these factors before deciding to approve or reject the request. The user can also decide to withdraw consent for a previously-approved request. This way, the user remains the custodian of their own data.

Already integrating? Checkout the AA Integration Guide here.

Try out our sample app built using Website Name AA sandbox here

#What can you build?

(website name)’s AA related services are powered by a licensed NBFC-AA partner. The AA framework opens up a lot of opportunities for FIU apps to build financial user journeys with seamless user consented data sharing. This allows developers to build tech-first user applications and features powered by digital data sharing flows over conventional PDF documents upload. Some of the use cases worth exploring:

1. Income Verification - Get access to users’ bank statements with their consents. While Website Name AA ensures that the data payload remains standardised and error free, simplify your user verification process and improve conversion rates!
2. Loan Monitoring - Monitor your borrower’s financial health after loan disbursal by analysing cash flow across a user’s bank accounts. As a lender, get early signals from a user's bank statements and prevent potential loan defaults.
3. Personal Finance Management - Help your users make better financial decisions. Pull transactions, categorise and track spending patterns across multiple bank accounts and much more.

Get started with (website name)'s mock FIP that lets you receive financial data across multiple FI types. We will soon add the ability for you to configure custom mock data sources. If you would like to test this feature, please reach out to us at aa@(website name).co.

#Building with (website name)'s AA stack

Website Name currently provides building blocks for FIU applications in conjunction with our licensed AA partner. This includes:

• HTTP APIs
  • Developers can call these APIs to create consent requests, test the approval or rejection of consent requests and fetch data for approved consent.
• End-user experience
  • Carefully built screens that your users can use to approve or reject incoming consent requests
  • This UI is built to be embeddable inside web and native mobile apps

Please check Website Name Insights to get actionable insights from a customer's bank statement.

#Quickstart Guide

Here is a brief summary of the steps to guide you through the integration process with (Website Name)'s Account Aggregator (AA). Before you begin, familiarize yourself with key terms that will be referenced in the documentation:

• AA or Account Aggregator: An entity licensed to present financial data requests to customers and manage consent approvals/rejections. (Website Name) collaborates with licensed AAs and provides pre-built, customizable screens for displaying data requests to your customers.
• FI— or Financial Information: The financial data of a user being requested.
• FIU or Financial Information User: The entity (you) requesting data from its customers.
• FIP or Financial Information Provider: The entity from which you request financial data, such as a bank or insurance provider.
• FI types / data sources—The various types of financial data you can request from your customers. (Website Name) AA offers mock data for all 23 FI data types enabled by AA.
• Consent Object— The core of the AA framework where you (the FIU) request consent from your customer to use one or more FI types. This includes details such as the reason for data request and how many times the data will be fetched. More details on the information sent as part of the consent request can be found here. here.

To get started, try out our sample app built using (Website Name) AA sandbox here

#Integrating FIU APIs on Sandbox

Create your product on the Bridge

• Register on The Bridge, if you haven’t already

• Set up an FIU by providing basic details

  
  

• Create Account Aggreagator Data product

  
  

Add configuration details

(Website Name) provides pre-built consent review screens that your customers can use. Your customer will use these screens to register/login to the AA, review the consent, link their accounts, and approve/reject consent.

You can set up a range of parameters that help you create a customised UX for your customers—

• Consent object details
• Consent approval UI should include your logo, FIU name, brand colours, and fonts
• Methods for discovering accounts
• Account selection conditions and help text for your customers

You can also enable developer specific features to reduce your integration efforts—

• Partial fetch
• Auto-Fetch data

Provide your endpoint to receive notifications

You will need to specify notification endpoints on the Bridge, the URL to which (Website Name) will send notifications.

You will be notified for two types of events—

• Actions by the user, such as accepting or rejecting a consent request
• Updates from the FIP, such as when the requested data is ready to be fetched

You can read about notifications in detail here.

Test your product

Once all the above steps are complete, you will find x-product-instance-id, x-client_id and x-client-secret in Step 2. You're now ready to make API calls using Postman on sandbox or integrate with sandbox FIU APIs.

#Moving to production

#Submit your product

After you have finished testing on sandbox, you can move to production. Except callback URL, all values filled in Step 1 of your product configuration will also apply for production environment.

• Fill the production callback URL in Step 3
• Complete your KYC in Step 4
• Submit your product for review in Step 5

#Post submission

(Website Name) will start the infrastructure (Website Name)p for your production FIU app. This involves two processes—

1. Sahamati's onboarding process for FIU. More details can be found in our go live docs.
2. We will deploy the FIU service on (Website Name)'s AWS with a subdomain based on your configuration. As soon as the infrastructure (Website Name)p is complete, your production credentials will be available in the API credentials section of the FIU. The x-product-instance-id will be the Product ID of the product you have set up.

#Ready to go!

Your users' financial data can now be accessed with their consent once you have these details.

#Test on Postman or integrate APIs

We recommend familiarizing yourself with all FIU APIs through Postman if you are just beginning integration. You can integrate directly with FIU APIs if you have already completed this.

#API integration

(Website Name)’s AA APIs can be broken down into 3 broad flows—

• Consent flow—Creating and sharing consent requests with your customers, as well as handling approvals and rejections.
• Data fetch flow—Once your customer approves the consent request, request and fetch the data.
• Notifications flow—Receive notifications from (Website Name) for key events like consent approvals/rejections or when FI data is ready.

Before starting integration, familiarise yourself with Consent Object which would act as a binding contract for all your data pulls.

#Consent flow

Get users' consent before you can start pulling their financial data with Website Name AA by initiating Consent flow in your application. This flow broadly consists of two parts:

1. Create Consent Request—This step entails generating a one-time data request that users must approve. For more details, refer to the Consent Object page. Upon creation, you will receive a unique ID with the status "PENDING" and a URL to redirect users to the consent manager screens. Users can then review the data request and either approve or reject it.

• Once a consent is created, you will receive a unique id with status = PENDING, along with a url where you can redirect your customer to consent manager screens, to review the data request. Here, the user may approve or reject the request

2. Consent Request status—Keep track of the consent status using the Get Consent Status API. Alternatively, (Website Name) will notify you when users take action on the consent request. Configure your notification endpoint using Notifications for timely updates.

#Create Consent API

Call this API to create a consent request. (Website Name)'s screens will display the details of the request to your customer.

POST /consents
{
"consentDuration":{
"unit":"MONTH",
"value":"4"
},
"vua":"999999999@onemoney",
"dataRange":{
"from":"2020-04-01T00:00:00Z",
"to":"2023-01-01T00:00:00Z"
},
"context":[
]
}

{
"id":"6d285134-c764-49ab-b32d-ead003161587",
"url":"https://fiu.(website name).co/v2/consents/webview/6d285134-c764-49ab-b32d-ead003161587",
"status":"PENDING",
"detail":{
"consentStart":"2023-04-10T05:36:43.011Z",
"fiTypes":["DEPOSIT"],
"fetchType":"PERIODIC",
"purpose":{
"category":{
"type":"string"
},
"refUri":"https://api.rebit.org.in/aa/purpose/101.xml",
"code":"101",
"text":"Loan underwriting"
},
"vua":"999999999@onemoney",
"dataRange":{
"from":"2020-04-01T00:00:00.000Z",
"to":"2023-01-01T00:00:00.000Z"
},
"consentTypes":["TRANSACTIONS","PROFILE","SUMMARY"],
"consentMode":"STORE",
"consentExpiry":"2023-08-08T05:36:43.011Z",
"frequency":{
"value":30,
"unit":"MONTH"
},
"dataLife":{
"value":1,
"unit":"MONTH"
}
},
"redirectUrl":"https://(website name).co",
"context":[],
"usage":{
"count":"0",
"lastUsed":null
},
"traceId":"1-6433a06a-4b99c3a81b538bc762b5aa08"
}

#Consent Review by customer

Upon redirecting your users to the specified url, it opens up a Consent Manager that permits consent approval/rejection. This url can easily be embedded as a webview or be used to redirect from a website. The URL is of the form:

https://<fiu-base-url>/consents/webview/<id>

• <fiu-base-url> — This is the base URL provided by (website name).
• <id> — This is the request ID of the consent generated returned after the create consent request.

On getting redirected to the url, your users will be asked to verify their mobile number to further initiate the account fetching process. The mobile verification does a login, or register them with Website Name using their mobile number. Website Name creates a unique account aggregator handle for every registered customer.

The following steps are handled by (website name)’s screens—

• OTP verification on the user's mobile number.
• (Website Name) authenticates the user and displays the data request.
• (Website Name) fetches data from Financial Information Providers (FIPs).
• Users link the FIPs and review the data request.
• (Website Name) validates and securely stores the consent.
• (Website Name) notifies you to confirm consent approval, indicating the status as either APPROVED or REJECTED

#Get Consent API

Call this API to get the consent details and the updated status of a consent request by passing its unique id.

If the consent is approved, the Status in the response will be ACTIVE. After this, you can now initiate Data flow for the approved consent request.

Request

 GET /consents/:id 

{
"url":"https://fiu.(website name).co/consents/v2/webview/e082b325-2692-47cd-88cf-875068df9051",
"status":"PENDING",
"context":[],
"vua":"999999999@onemoney",
"consentStart":"2023-04-04T07:10:41.165Z",
"consentExpiry":"2023-08-02T12:40:41.165Z",
"traceId":"26b8bc4c-5d33-43a1-a58f-be5d4d0acbd0"
}
}

{
"url":"https://fiu.(website name).co/v2/consents/webview/73633c01-d14d-4dbb-8a82-d82e53df5920",
"status":"PENDING",
"detail":{
"purpose":{
"refUri":"https://api.rebit.org.in/aa/purpose/101.xml",
"code":"101",
"text":"Loan",
"category":{
"type":"string"
}
},
"consentStart":"2023-05-22T07:39:41.333Z",
"fiTypes":[
"DEPOSIT",
"EQUITIES",
"MUTUAL_FUNDS",
"GST_GSTR3B",
"GST_GSTR2A",
"GST_GSTR1"
],
"frequency":{
"value":3,
"unit":"MONTH"
},
"fetchType":"PERIODIC",
"vua":"99999999999@onemoney",
"dataLife":{
"value":1,
"unit":"YEAR"
},
"consentExpiry":"2023-09-19T13:09:41.333Z",
"dataFilter":[],
"consentTypes":["TRANSACTIONS","PROFILE"],
"dataRange":{
"from":"2020-04-01T00:00:00.000Z",
"to":"2023-01-01T00:00:00.000Z"
},
"consentMode":"STORE"
},
"context":[],
"usage":{
"lastUsed":null,
"count":"0"
},
"traceId":"74d3032a-597e-40e1-859b-67b035e8a0e0"
}

#Data Flow

The APIs you need to use to fetch FI data are listed below. Once your customer has approved the consent request, you can use these APIs. The flow mainly involves data fetching against a valid data session with below APIs.

• Create Data Session—Call this API against an APPROVED consent. This initiates data preparation at user's linked FIP accounts. You will be notified by (Website Name) once the data is ready to be fetched.
• Fetch FI data—Fetch decrypted FI data with data session id.

#Create new Data Session API

Call this API to create a data session against the approved consentId.

Request

Specify the format in which you wish to receive the decrypted financial data, this can be xml or json.

POST /sessions
{
"consentId":"d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
"dataRange":{
"from":"2016-12-06T11:39:57.153Z",
"to":"2021-12-31T14:25:33.440Z"
},
"format":"json"
}

{
"format":"json",
"fips":null,
"dataRange":{
"to":"2021-06-30T16:30:16.363Z",
"from":"2021-05-30T11:39:57.154Z"
},
"id":"f608b1c5-60cb-445d-8355-76a9cc053535",
"status":"PENDING",
"consentId":"c8b03bc3-6b6c-45e2-a604-6f7ec4541e57",
"traceId":"1-646c4a4c-34b8663b0f1238aa04412e89"
}

#Fetch FI data

As and when each FIP in the data session responds with an update, (Website Name) will notify you on the webhook endpoint you configure. SeeFI notifications.

This API can be used when the combined data session status in the notification is either PARTIAL or COMPLETE

Request

If you request for multiple FI types, you will receive all the FI data from end-user's linked accounts in an array.

GET /sessions/:id

Response

{
"status":"PARTIAL",// combined data session status
"format":"json",
"fips":[
{
"accounts":[
{
"linkRefNumber":"b2329f47-0a6f-4131-adb5-9ef7b4c1ca6a",
"maskedAccNumber":"XXXXXX4373",
"status":"DELIVERED"// individual account FI status
"data":{
"account":{
"linkedAccRef":"b2329f47-0a6f-4131-adb5-9ef7b4c1ca6a",
"maskedAccNumber":"XXXXXX4373",
"type":"deposit",
"version":"1.1",
"profile":{
"holders":{
"type":"SINGLE",
"holder":{
"address":"8/1190, 5th Cross, 3rd Main, 7th Block, Jayanagar, Bangalore - 560011",
"ckycCompliance":"true",
"dob":"1947-08-15",
"email":"[email protected]",
"landline":"",
"mobile":"8569884373",
"name":"Akshay Kumar",
"nominee":"REGISTERED",
"pan":"AAAAA0000A"
}
}
},
"summary":{
"currentBalance":"101666.33",
"currency":"INR",
"branch":"Jayanagar 4th Block",
"balanceDateTime":"2020-06-22T07:50:00+00:00",
"currentODLimit":"0",
"drawingLimit":"0",
"exchgeRate":" ",
"facility":"OD",
"ifscCode":"ICIC0001124",
"micrCode":"500240246",
"openingDate":"2004-08-06",
"status":"ACTIVE",
"type":"SAVINGS",
"Pending":{
"transactionType":"DEBIT",
"amount":"0"
}
},
"transactions":{
"startDate":"2021-04-01",
"endDate":"2021-09-30"
}
}
},
}
],
"fipID":"(website name)-FIP"
},
{
"accounts":[
{
"linkRefNumber":"b2329f47-0a6f-4131-adb5-9ef7b4c1ca6a",
"maskedAccNumber":"XXXXXX4373",
"FIstatus":"FAILED",// individual account FI status
"data":null
}
],
"fipID":"ACME-FIP"
}
],
"id":"378ec65c-f558-49fc-89ea-e880c2cf88b3",
"dataRange":{
"from":"2021-04-01T00:00Z",
"to":"2021-09-30T00:00Z"
},
"consentId":"d4f40bd9-a22f-4408-a622-4e8a1e4fbda6"
}

#Auto-Fetch data feature

Once a consent has been approved, FIUs must create a data session, listen to notifications, and then fetch FI data.

Auto-Fetch data feature aims to absorb this complexity from the FIUs. With Auto-Fetch data feature enabled, the process will look like this—

1. Consent is approved by the customer.
2. (Website Name) creates a data session automatically.
3. (Website Name) listens to FI notifications and manages retries.
4. Once the combined data session status is PARTIAL or COMPLETED, (Website Name) fetches the FI data and sends it to the FIU.
   • For one time consents, Auto-Fetch executes only once, right after the consent is approved.
   • For recurring consents, Auto-Fetch can fetch data periodically. Set up the frequency of Auto-Fetch data in your configuration on the Bridge.

Auto fetch notification payload

POST /your-webhook-endpoint
{
"type":"FI_DATA_READY",
"consentId":"58180119-15bc-454f-83bb-192efda9321b",
"dataRange":{
"from":"2023-07-25T11:27:01.069Z",
"to":"2023-07-25T11:28:00.648Z"
},
"fiData":[
{
"fipID":"(website name)-fip",
"data":[
{
"linkRefNumber":"4b4cc8fb-89eb-41c3-bc64-fec2497d5454",
"maskedAccNumber":"XXXXXXXX7561",
"decryptedFI":{
"account":{
"linkedAccRef":"4b4cc8fb-89eb-41c3-bc64-fec2497d5454",
"maskedAccNumber":"XXXXXXXX7561",
"type":"deposit",
"version":"1.1",
"profile":{
"holders":{
"type":"SINGLE",
"holder":[
{
"address":"758, Das Nagar Bikaner 455148",
"ckycCompliance":"false",
"dob":"1983-09-08",
"email":"buchzain@(website name)-dummy.com",
"mobile":"3536459776",
"name":"Tushar Balakrishnan",
"nominee":"REGISTERED",
"pan":"SMPXE2207K"
}
]
}
},
"transactions":{
"startDate":"2020-04-01T00:00:00.000Z",
"endDate":"2023-01-01T00:00:00.000Z",
"transaction":[
{
"amount":"33834.65",
"currentBalance":"489971.1",
"mode":"UPI",
"narration":"UPI/CR/457233689286/Gatik Yohannan/CZBR/64321752",
"reference":"966712146",
"transactionTimestamp":"2020-05-08T11:05:29+00:00",
"txnId":"EUCE23840883221703",
"type":"CREDIT",
"valueDate":"2020-05-09T11:05:29+00:00"
},
{
"amount":"16480.04",
"currentBalance":"408905.24",
"mode":"UPI",
"narration":"UPI/CR/988357930370/Dhruv Desai/RZJF/85716960",
"reference":"510260839",
"transactionTimestamp":"2020-12-16T21:49:14+00:00",
"txnId":"ZJGE96715479740775",
"type":"CREDIT",
"valueDate":"2020-12-17T21:49:14+00:00"
}
//more transactions
]
}
}
}
}
]
}
]
}

#Notifications

The API endpoints you need to implement on your server and expose to receive notifications from (Website Name) AA are listed below. These notifications are webhooks from (Website Name) based on the events that occur during the consent and data flow.

The base_url is the server URL you share with us to receive notifications.

With Beeceptor, you can quickly create a mock API endpoint. (Website Name) will send notifications to that URL once it has been configured on Bridge. This will help you understand the notification flow before you start to implement it on your server.

Types of notifications

• Consent notification—notification triggered for the events that occur in consent flow
• FI notification—notification triggered for the events that occur in data flow

Note: Webhooks retries will be added in future iterations.

#Consent notification

This notification is used to communicate the updated status of the consent. We do not send notification for consent status PENDING PENDING.

Consent notification Payload

(Website Name) will post this payload to your notification endpoint whenever there is a change in consent status.

{
"data":{
"status":"ACTIVE",
"detail":{
"accounts":[
{
"maskedAccNumber":"XXXXXXXX6053",
"accType":"CURRENT",
"fipId":"(website name)-fip",
"fiType":"DEPOSIT",
"linkRefNumber":"e4b27e62-e41a-42c0-a5b3-0a5542b25ddf"
}
]
}
},
"timestamp":"2023-04-03T09:14:43.323Z",
"success":true,
"type":"CONSENT_STATUS_UPDATE",
"error":null,
"consentId":"c16cc10e-eae3-4277-96e1-64c0ed21c53e"
}

#FI notification

Financial Information (FI) notifications are used to communicate data session statuses created using the Create Data Session API. You will receive a notification whenever each FIP in the data session responds with an update.

The FI notification payload contains two statuses—

• Individual account FI status
• Combined data session status

FI Notification Payload

{
"data":{
"status":"COMPLETED",// combined data session status
"fips":[
{
"accounts":[
{
"FIStatus":"READY",// individual account FI status
"description":"fi status description not found from FIP",
"linkRefNumber":"e4b27e62-e41a-42c0-a5b3-0a5542b25ddf"
}
],
"fipID":"(website name)-fip"
}
],
"format":"json"
},
"timestamp":"2023-04-03T09:20:53.424Z",
"dataSessionId":"32d40afc-4795-495d-8ca4-d817d730e5b5",
"success":true,
"type":"SESSION_STATUS_UPDATE",
"error":null,
"consentId":"c16cc10e-eae3-4277-96e1-64c0ed21c53e"
}

#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

• Activates and deactivates FIPs dynamically.
• Checks the status of FIPs on the ecosystem, whether they are active or inactive.
• A user's account can be used by FIUs to select FIPs/providers.

#Below are the parameters shared in the FIP List API that give you each of the relevant details of the FIPs. By using these key details, you can provide your end-users with a list of FIPs to choose from or route them to the (Website Name) AA flow based on whether an FIP is active.

Status	Description
Name	The name of the FIP - this is typically their brand name in camel case format.
FIP ID	The 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 TYPES	This 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
Status	The 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.

#FIP List API

Request

 GET /v2/fips 

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

Using Get FIP List for routing end-users to AA Flows

To route users and select Financial Information Providers (FIPs) as an FIU, you can leverage the FIP List API, which allows you to direct end users to either the Account Aggregator (AA) flow or non-AA flows (such as PDF uploads, net banking integrations, or alternative data collection modes) based on the FIPs' activation status.

The two methods are as follows.

• Standard User Selection of FIPs: This allows customers to select FIPs (Banks, insurers, securities providers, etc.) when they start the consent flow

• Custom routing an FIP selection: The API allows FIUs to either select FIPs on their own page OR “pre-select” FIPs (up to 6 FIPs can be selected in this method) and auto-discover accounts by passing the FIP ID in the context parameter.

#Consent object

The consent object is the core of the AA framework. When an FIU requires data about the user, the request is packaged in the form of a consent object.

Consent object contains the information about all the different types of data the FIU needs, the purpose of the data, and how the FIU plans to use the data and so on.

#Consent request object

#Context property examples

Filter by account type

"context":[
{
"key":"accounttype",
"value":"CURRENT"
}
]

Filter by FIP ids

"context":[
{
"key":"fipId",
"value":"(website name)-fip,icici-fip"
}
]

Filter by excluding FIP ids

"context":[
{
"key":"excludeFipIds",
"value":"(website name)-fip,icici-fip"
}
]

#Consent response object

#FI data types

The Account Aggregator(AA) ecosystem supports 23 FI types spread across bank, insurance, pension and investments FI types as discussed below.
The schema across all FI types adheres to a set of defined components:

• Profile -Gives account holder information like name, date of birth, nominee etc.
• Summary -Summarises the account information like account type, current balance, opening details etc.
• Transactions - Contains list of transactions with details like transaction type, mode, narration among others.

#Testing with Website Name FIP

Website Name FIP to help you get access to rich mock data for FI type Deposit as per the Account Aggregator specifications. More FI types will be available soon.

How to test?

1. Call Create Consent Request API
2. Open url to initiate consent manager flow
3. Select and link Website Name FIP and approve the consent
   
   • The approved consent allows you to initiate Data flow with Website Name FIP
     
4. Create a Data Session for the approved consent
   
   • Website Name FIP prepares the data as per your consent request
     
5. Call Fetch FI Data and get Deposit FI data from Website Name FIP
   

This page will help you understand the structure of each FI type and what data will be available for you to build on top of. These FI types contain one account per FI type with 15 to 30 transactions spread across 6 months (Jan 1, 2021 to June, 30, 2021). We're adding dynamic mock data for more realistic and exhaustive integration testing.

#Bank FI Types

{
"type":"deposit",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":[
{
"address":"4/1290, 785th Cross, 13rd Main, 7th Block, Bangalore - 569911",
"ckycCompliance":"true",
"dob":"24-07-1970",
"email":"[email protected]",
"landline":"",
"mobile":"91729391923",
"name":"Ramkrishna Sapan",
"nominee":"REGISTERED",
"pan":"AAAPL1234C"
}
],
"type":"Single"
}
},
"summary":{
"balanceDateTime":"2021-06-22T13:20:00+05:30",
"branch":"Jayanagar 7th Block",
"currency":"INR",
"currentBalance":"101666.33",
"currentODLimit":"0",
"drawingLimit":"0",
"exchgeRate":"",
"facility":"OD",
"ifscCode":"APNB0001154",
"micrCode":"500245646",
"openingDate":"06-08-1999",
"pending":{
"amount":"0",
"transactionType":"DEBIT"
},
"status":"ACTIVE",
"type":"SAVINGS"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"1239",
"currentBalance":"62289.25",
"mode":"UPI",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"reference":"RFN00013383",
"transactionTimestamp":"2021-04-01T13:20:14+05:30",
"txnId":"M3258741",
"type":"DEBIT",
"valueDate":"2021-04-01"
},
      .......
]
}
}

{
"type":"term_deposit",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":[
{
"address":"4/1290, 785th Cross, 13rd Main, 7th Block, Bangalore - 569911",
"ckycCompliance":"true",
"dob":"24-07-1970",
"email":"[email protected]",
"landline":"",
"mobile":"91729391923",
"name":"Ramkrishna Sapan",
"nominee":"REGISTERED",
"pan":"AAAPL1234C"
}
]
}
},
"summary":{
"accountType":"FIXED",
"branch":"Jayanagar 7th Block",
"compoundingFrequency":"HALF-YEARLY",
"currentValue":"119845.90",
"description":"",
"ifsc":"APNB0001154",
"interestComputation":"COMPOUND",
"interestOnMaturity":"",
"interestPayout":"HALF-YEARLY",
"interestPeriodicPayoutAmount":"",
"interestRate":"2",
"maturityAmount":"10.0",
"maturityDate":"12-11-2021",
"openingDate":"06-08-2019",
"principalAmount":"109890.98",
"recurringAmount":"2453",
"recurringDepositDay":"06-08-2019",
"tenureDays":"180",
"tenureMonths":"6",
"tenureYears":"0.5"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"1239",
"currentBalance":"62289.25",
"mode":"UPI",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"reference":"RFN0TD0013383",
"transactionTimestamp":"2021-04-01T13:20:14+05:30",
"txnId":"TD3258741",
"type":"DEBIT",
"valueDate":"2021-04-01"
},
      .......
]
}
}

{
"type":"recurring_deposit",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":[
{
"address":"4/1290, 785th Cross, 13rd Main, 7th Block, Bangalore - 569911",
"ckycCompliance":"true",
"dob":"24-07-1970",
"email":"[email protected]",
"landline":"",
"mobile":"91729391923",
"name":"Ramkrishna Sapan",
"nominee":"REGISTERED",
"pan":"AAAPL1234C"
}
],
"type":"JOINT"
}
},
"summary":{
"accountType":"FIXED",
"branch":"Jayanagar 7th Block",
"compoundingFrequency":"HALF-YEARLY",
"currentValue":"119845.90",
"description":"",
"ifsc":"APNB0001154",
"interestComputation":"COMPOUND",
"interestOnMaturity":"",
"interestPayout":"HALF-YEARLY",
"interestPeriodicPayoutAmount":"",
"interestRate":"2",
"maturityAmount":"10.0",
"maturityDate":"12-11-2021",
"openingDate":"06-08-2019",
"principalAmount":"109890.98",
"recurringAmount":"2453",
"recurringDepositDay":"06-08-2019",
"tenureDays":"180",
"tenureMonths":"6",
"tenureYears":"0.5"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"1239",
"currentBalance":"62289.25",
"mode":"UPI",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"reference":"RFN0RD0013383",
"transactionTimestamp":"2021-04-01T13:20:14+05:30",
"txnId":"RD3258741",
"type":"DEBIT",
"valueDate":"2021-04-01"
},
      .......
]
}
}

{
"type":"credit_card",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":{
"cards":{
"card":[
{
"cardType":"RUPAY",
"issuedDate":"12-04-2006",
"maskedCardNumber":"4321-XXXXXXXX-9876",
"primary":"YES"
}
]
},
"ckycCompliance":"true",
"dob":"24-07-1970",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Ramkrishna Sapan",
"nominee":"REGISTERED",
"pan":"AAAPL1234C"
}
}
},
"summary":{
"availableCredit":"51345",
"cashLimit":"20000",
"creditLimit":"60000",
"currentDue":"3000",
"dueDate":"20-06-2021",
"financeCharges":"2368",
"lastStatementDate":"20-05-2021",
"loyaltyPoints":"2450",
"minDueAmount":"1346",
"previousDueAmount":"7654",
"totalDueAmount":"9756"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"1239",
"maskedCardNumber":"4321-XXXXXXXX-9876",
"mcc":"RFN0RD0013383",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"statementDate":"20-04-2021",
"txnDate":"2021-04-01T13:20:14+05:30",
"txnId":"RD3258741",
"txnType":"DEBIT",
"valueDate":"2021-04-01"
},
      .......
]
}
}

{
"type":"cd",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":{
"ckycCompliance":"true",
"dematId":"Y68HS92S09S",
"dob":"24-07-1980",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Manisha Vijayakumar",
"nominee":"REGISTERED",
"pan":"BYHPL1234T"
}
}
},
"summary":{
"currentValue":"213000",
"holdings":{
"holding":{
"companyName":"Deposits Registry Ltd.",
"description":"",
"faceValue":"230000",
"isin":"DRL893455",
"issueDate":"2021-02-12",
"issuerName":"Mukesh Y",
"lastTradedDate":"2021-04-12",
"lastTradedRate":"2",
"maturityDate":"2024-02-12",
"scheme":"TERM",
"symbol":"",
"tenureDays":"120",
"tenureMonths":"36",
"tenureYears":"3",
"yield":"6"
},
"type":"CD"
},
"investmentValue":"200000"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"currency":"INR",
"isin":"DRL893455",
"narration":"",
"otherTaxes":"34",
"rate":"15000",
"stt":"23",
"totalCharge":"2450",
"tradeValue":"1345",
"transactionDateTime":"2021-01-12T13:20:00-05:00",
"txnId":"CDR9084JED",
"type":"BUY",
"units":"1"
},
      .......
]
}
}

{
"type":"idr",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":{
"ckycCompliance":"true",
"dob":"24-07-1970",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Ramkrishna Sapan",
"nominee":"REGISTERED",
"pan":"AAAPL1234C"
}
}
},
"summary":{
"currentValue":"23459.0",
"investment":{
"holdings":{
"holding":{
"description":"",
"investmentDateTime":"2021-04-12T13:20:00-05:00",
"isin":"APNDR",
"issuerName":"APNA Depository Receipts",
"lastTradedPrice":"70",
"rate":"6",
"units":"30"
},
"type":"DEMAT"
}
},
"investmentValue":"12000.0"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"companyName":"",
"exchange":"BSE",
"isin":"INUS-000402625-0",
"narration":"",
"orderId":"ORD98703245",
"otherCharges":"109",
"rate":"8",
"shareHolerEquityType":"COMMON-STOCK",
"symbol":"",
"totalCharge":"100",
"tradeId":"TIDR76TY90",
"tradeValue":"109",
"transactionDateTime":"2021-04-12T13:20:00-05:00",
"txnId":"M59555532",
"type":"BUY",
"units":"10"
},
      .......
]
}
}

#Insurance FI types

{
"type":"insurance_policies",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":[
{
"ckycCompliance":"true",
"dob":"24-07-1980",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Manisha Vijayakumar",
"nominee":"REGISTERED",
"pan":"BYHPL1234T",
"rank":"1"
}
],
"type":"JOINT"
},
"riders":{
"rider":[
{
"policyEndDate":"12-03-2033",
"policyStartDate":"12-03-2021",
"premiumAmount":"1600000",
"riderType":"Waiver of premium",
"sumAssured":"1500000",
"tenureMonths":"144",
"tenureYears":"12"
}
]
}
},
"summary":{
"contractClauses":{
"contractClause":[
{
"amount":"75000",
"conditions":"",
"description":"",
"exlcusions":"",
"subLimit":"",
"title":"Children Plan"
}
]
},
"coverAmount":"1300000",
"coverType":"BUILDING",
"covers":{
"cover":[
{
"amount":"120000",
"description":""
}
]
},
"eiaNumber":"TY67HG5THL",
"maturityBenefit":"",
"maturityDate":"2004-04-12",
"moneyBacks":{
"moneyBack":[
{
"amount":"1000",
"date":"12-03-28",
"description":""
}
]
},
"policyName":"APNA Life Insurance",
"policyNumber":"APNI789008",
"policyStartDate":"12-03-2021",
"policyType":"CHILDREN_PLAN",
"premiumAmount":"1600000",
"premiumFrequency":"HALF_YEARLY",
"premiumPaymentMonths":"24",
"premiumPaymentYears":"2",
"sumAssured":"1500000",
"tenureMonths":"144",
"tenureYears":"12"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"5000",
"narration":"BIL/BPAY/001982030055/BSE ISIP/BSE000000034260 ",
"txnDate":"2021-05-09T18:33:56+05:30",
"txnId":"M69761383",
"type":"BONUS"
},
      .......
]
}
}

{
"type":"ulip",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"type":"JOINT",
"holder":{
"ckycCompliance":"true",
"dob":"24-07-1980",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Manisha Vijayakumar",
"nominee":"REGISTERED",
"pan":"BYHPL1234T",
"dematId":"A8SD39DSD"
}
},
"riders":{
"rider":{
"riderType":"Waiver of premium",
"sumAssured":"1000",
"tenureYears":"2",
"tenureMonths":"24",
"policyStartDate":"2021-01-12",
"policyEndDate":"2023-01-12",
"premiumAmount":"200000",
"description":""
}
}
},
"summary":{
"type":"HEALTH",
"productName":"HEALTH INSURANCE",
"productDescription":"",
"sumAssured":"209000",
"tenureYears":"2",
"tenureMonths":"24",
"premiumAmount":"100",
"policyStartDate":"2021-01-12",
"policyMaturityDate":"2023-01-12",
"premiumFrequency":"HALF_YEARLY",
"premiumPaymentYears":"1",
"premiumPaymentMonths":"12",
"nextPremiumDueDate":"2021-01-12",
"holdings":{
"holding":{
"name":"APNA Insurance",
"type":"BALANCED",
"units":"2",
"cost":"200",
"nav":"",
"allocationPercentage":"4",
"premiumAllocation":"5",
"currentValue":"2090",
"description":""
}
}
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"txnDate":"2021-01-09T18:33:56+05:30",
"txnId":"M69761383",
"fundName":"",
"units":"2",
"nav":"10",
"navDate":"2021-04-12",
"cost":"1000",
"premium":"200",
"premiumAllocationCharge":"20",
"otherCharges":"10",
"type":"CHANGES_IN_MATURITY_DATE",
"narration":""
},
      .......
]
}
}

#Pension FI types

{
"type":"epf",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":{
"ckycCompliance":"true",
"dob":"24-07-1989",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Gurmeet Patel",
"nominee":"REGISTERED",
"pan":"BTHPL6749C"
}
}
},
"summary":{
"currentBalance":"280000",
"employeeBalance":"100000",
"employerBalance":"200000",
"establishmentId":"ISI-PS-23943",
"establishmentName":"Public Services Ltd.",
"openingDate":"2011-01-12",
"totalBalance":"300300"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"employeeDepositAmount":"1239",
"employeeWithdrawalAmount":"500",
"employerDepositAmount":"1000",
"employerWithdrawalAmount":"100",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"pensionFundAmount":"62289.25",
"txnDate":"2021-04-01T13:20:14+05:30",
"txnId":"M3258741",
"type":"ADJUSTMENT"
},
      .......
]
}
}

{
"type":"ppf",
"masked_account_number":"XXXXXXX123",
"link_ref_number":"123456789",
"profile":{
"holders":{
"holder":[
{
"ckycCompliance":"true",
"dob":"24-07-1985",
"email":"[email protected]",
"mobile":"91729391923",
"name":"Avinash Mishra",
"nominee":"REGISTERED",
"pan":"AAAPL6789C"
}
],
"type":"JOINT"
}
},
"summary":{
"branchAddr":"",
"currenBalance":"1000000",
"ifscCode":"APNB0001154",
"maturityDate":"2021-12-12",
"micrCode":"500245646",
"openingDate":"2021-01-01",
"status":"ACTIVE"
},
"transactions":{
"endDate":"",
"startDate":"",
"transaction":[
{
"amount":"1239",
"balance":"62289.25",
"narration":"UPI/935314560764/getsimpl/simpl@axisbank/Axis Bank",
"txnDate":"2021-04-01T13:20:14+05:30",
"txnId":"M3258741",
"type":"DEPOSIT",
"valueDate":"2021-04-01"
},
      .......
]
}
}