#What is (Website Name) Insights?

The Insight API from (Website Name) provides actionable insights regarding a customer's income, expenditures, and financial history, extracted from their bank statement.

In addition to financial data uploaded through the Account Aggregator (AA), the (Website Name) Insights API also processes data from external sources such as PDF. The generated insights have the potential to be customized in order to meet your particular needs, which may include anything from personal finance management to underwriting use cases.

#What can you do with this product?

(Website Name) Insights allows you to analyze a wide range of financial statements, such as bank statements, GST returns, securities accounts, etc. Some possible use-cases include—

• Income verification and underwriting— Analyze bank statements to verify applicant income and assess creditworthiness. Extract income sources, evaluate financial stability and streamline the loan approval process.
• Loan monitoring — Monitor borrower's financial health and loan obligations. Track cash flow, identify irregularities and manage loan portfolios effectively. Stay proactive with real-time insights into borrower's ability to meet loan obligations and mitigate risks.
• Personal finance management and wealth management—Enable individuals to effectively manage their personal finances. Assemble expenditure reports, classify transactions, and acquire knowledge to establish financial objectives and make well-informed choices. Access comprehensive financial data in order to provide wealth managers with individualized guidance and customized investment strategies.

#How does it work?

1. Feed data—After receiving authorization from the customer to access their financial data, the FIP proceeds to transmit the finance data to you (FIU) through the AA gateway. This information is inputted into (Website Name) Insights for analysis. Consult AA documents for a concise explanation of FIU, FIP, and AA.

2. Analyse financial data—The unprocessed data is subjected to a categorization model developed by (Website Name) Insights, which loads it into distinct buckets representing incomes, expenses, and more.

3. Get reports—Post analysis, the insights are provided to you in the format of your choice.

#Quickstart Guide

Here is a quick summary of steps to help you integrate with (Website Name)’s Insights API. Before you start, there are some key terms that will be referred to periodically in the documentation—

• FI Data block—FI The data blocks obtained through the AA are the information provided by the FIP (Financial information provider). At this time, only bank statement datablocks are supported.
• Template—A template is a pre-established format that dictates the organization of the produced report, as well as the selection of insights to be produced. You have complete control over which insights are included in a template, according to your specific requirements. For instance, if the intention is to produce insights pertaining solely to a customer's expenses and income, the template may solely comprise such information.

#Step 1—Template creation

You need to send in the below information to insights@(Website Name).co, for setting up your template.

(Website Name) will create a template for you and share a templateID, which can be used in the API calls.

#Step 2—Feed data

Once you have obtained a user's financial information, you can import it as a FI Data block into (Website Name) Insights. For each newly created FI Data block, a dataId is assigned. In order to integrate with data ingestion APIs, consult API integration.

#Step 3—Generate insights

You can generate insights for each FI Data block that is created in the previous step. To generate insights, pass the templateId and dataId from the previous steps.

The reportId identifies an insight report, which will be delivered to you asynchronously via the notification URL you supply. Additionally, a generated insight can be retrieved at any time using the reportId. To integrate with the APIs used for Insight generation, consult API integration.

#Test on Postman or integrate APIs

You should familiarise yourself with setting up Postman and configuring credentials if you are just getting started with the integration. If you have already completed this step, you can integrate with the (Website Name) Insights APIs directly.

#Test (Website Name) Insights APIs with Postman

#Download and set up Postman

Install the Postman application, should you not have done so already. In this collection, every API required to utilize (Website Name) Insights has been made available. In the upper right corner, click Run in Postman to import the (Website Name) Insight API collection into Postman.

Update environment variables

Postman environment comes wth default test credentials, which are passed as headers for every request in the collection. Set the following variables in the environment on Postman—

• Set clientId to the FIU app client ID received from our support team. This variable is passed as the x-client-id header.
• Set clientSecret to the FIU app client secret received from our support team. This variable is passed as the x-client-secret header.
• Set productInstanceId to the FIU product instance ID received from our support team. This variable is passed as the x-product-instance-id header.

Hit Save after all the changes are complete.

Next, you're now ready to feed data and generate insights by trying the following APIs provided in the Postman collection—

• Data ingestion APIs—Create FI Data blocks and get list of created FI data blocks
• Insight generation APIs—Create Insights reports and fetch generated reports

#API integration

Here are the URLs you would need for calling Website Name Insights APIs—

• Sandbox—https://di-uat.(Website Name).co
• Production—https://insights.(Website Name).co
• Headers—Contact (Website Name) for providing the credentials required to successfully call (Website Name) APIs. This contains—
  • x-client-id
  • x-client-secret
  • x-product-instance-id

#Data ingestion APIs

#Create FI Data block API

This API creates FI data blocks for user data that you wish to feed into (Website Name) Insights.

Request

The financial data should be sent in the body as a payload. The payload should be the same as the FIP data. The payload is validated against the ReBIT schema.

POST /v1/fiData 
{
  account:{
    profile:{
      holders:{
        holder:[
{
            name: 'string',
            dob: '2019-08-24',
            mobile:0,
            nominee: 'REGISTERED',
            landline: 'string',
            address: 'string',
            email: 'string',
            pan: 'string',
            ckycCompliance:true
}
],
        type: 'SINGLE'
}
},
    summary:{
      pending:{transactionType: 'CREDIT', amount:0},
      currentBalance: 'string',
      currency: 'string',
      exchgeRate: 'string',
      balanceDateTime: '2019-08-24T14:15:22Z',
      type: 'SAVINGS',
      branch: 'string',
      facility: 'OD',
      ifscCode: 'string',
      micrCode: 'string',
      openingDate: '2019-08-24',
      currentODLimit: 'string',
      drawingLimit: 'string',
      status: 'ACTIVE'
},
    transactions:{
      transaction:[
{
          type: 'CREDIT',
          mode: 'CASH',
          amount:0,
          currentBalance: 'string',
          transactionTimestamp: '2019-08-24T14:15:22Z',
          valueDate: '2019-08-24',
          txnId: 'string',
          narration: 'string',
          reference: 'string'
}
],
      startDate: '2019-08-24',
      endDate: '2019-08-24'
},
    type: 'deposit',
    maskedAccNumber: 'string',
    version:0,
    linkedAccRef: 'string'
}
}

Response

{
"status":"Success",
"statusDescription":"statusDescription",
"body":{
"dataId":"4e0ba220-9575-11eb-a8b3-0242ac130003",
"fiSchema":"deposit",
"expiryDate":"2023-05-16T09:23:39.115Z"
}
}

#Get FI data blocks API

Call this API to get a list of all FI data blocks created by you.

Request

GET /v1/fiData

Response

{
"status":"Success",
"statusDescription":"statusDescription",
"body":[
{
"dataId":"4e0ba220-9575-11eb-a8b3-0242ac130003",
"fiSchema":"deposit",
"expiryDate":"2023-05-16T10:16:53.334Z"
}
]
}

#Insight generation APIs

#Create Insight report

Use this API to generate an Insights report based on the FI data block you created earlier. The dataId identifies each FI data block. Pass the templateId obtained from template creation step, which will determine the ouput insights parameters that will be present in the report.

Request

Send the list of FI data block IDs and the template ID as the payload.

POST /v1/insight
{
"templateId":"4777db7e-e604-4c0c-a410-51be9d17d00b",
"dataIds":[
"cfbd63ef-ea1a-44b2-a9e8-9f834214f5c6"
]
}

Response

{
"status":"Success",
"body":{
"reportId":"4b108e83-07b6-47a4-84cd-a77d0e9e2b3d",
"status":"in-progress"
}
}

#Get Insight report

The Insights report can be retrieved by calling this API. As a URL parameter, pass the reportId returned in the response body of Create Insight report API.

Request

GET /v1/insight?reportId=4b108e83-07b6-47a4-84cd-a77d0e9e2b3d

Response

{
"status":"Success",
"body":{
"name":"Redacted Services",
"dob":"2006-06-27",
"email":"[email protected]",
"pan":"redacted",
"ckyc_compliance":false,
"mobile":9999912345,
"bank_branch":"NARKATIAGANJ BH",
"bank_account_number":"XXXXXXXXXXX1234",
"bank_account_type":"CURRENT",
"opening_date":"2019-02-26",
"closing_balance":27929.84,
"end_of_month_balances":{
"2021":{
"9":245676.89,
"10":48650.54,
"11":145487.41,
"12":97725.67
},
"2022":{
"1":9152.09,
"2":5957.19,
"3":545.59,
"4":1282299.18,
"5":134376.04,
"6":84468.46,
"7":135585.11,
"8":3346.11,
"9":268766.7,
"10":50049.84,
"11":27929.84
}
},
"balances_on_10th":{
"2021":{
"12":55387.41
},
"2022":{
"1":2426.67,
"2":9629.59,
"3":97487.45,
"4":1641.09,
"5":52517.54,
"6":72084.28,
"7":165864.04,
"8":63465.11,
"9":11226.11,
"10":418535.81,
"11":27929.84
}
},
"average_end_of_day_balance":297715.03,
"maximum_end_of_day_balance":1818766.7,
"total_credits":153,
"total_credits_value":44810341.06,
"total_debits":473,
"total_debits_value":45178088.11,
"quarterly_salary_average":{
"2021":{
"4":15072
}
},
"cash_deposit_x_total_credit":{
"2021":{
"12":0.0095
},
"2022":{
"3":0.0018
}
}
}
}

#List of insights

You can create templates by picking only those insights that you need. Below is a list of all available insights that (Website Name) Insights can provide—

#Notifications

Notifications are webhooks from (Website Name) that provide the data you requested.

During template creation, you shared the Notification endpoint, which is the base_url configured to receive notifications.

#Insights generated notification

This notification is used to communicate the generated insights which was requested by you in Create Insight Report API. .

Notification payload

(Website Name) will post this payload to your notification endpoint when Insights report is successfully generated.

{
"type":"INSIGHT_STATUS_UPDATE",
"timestamp":2018-12-06T11:39:57.153Z,
"jobId":"d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
"success":true,
"data":{
"status":"READY",
"insights":{
// ... insight_name : insight_value
}
},
"error":{}
}