Skip to content

Commit 548fe39

Browse files
aditya-67aditya-67
committed
Add v1 Insights documentation
1 parent 8e16e6e commit 548fe39

File tree

8 files changed

+679
-1
lines changed

8 files changed

+679
-1
lines changed

‎content/data/insights/v1/api-reference.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
sidebar_title: API reference
3+
page_title: Setu Insights API reference
4+
order: 4
5+
visible_in_sidebar: true
6+
---

‎content/data/insights/v1/insights.mdx

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
sidebar_title: List of insights
3+
page_title: All Setu insights
4+
order: 2
5+
visible_in_sidebar: true
6+
---
7+
8+
## List of insights
9+
10+
You can create templates by picking only those insights that you need. Below is a list of all available insights that Setu Insights can provide—
11+
12+
| Insight name | Details |
13+
| ---------------------------------------- | ------------------------------------------------------------------- |
14+
| `name` | Name of the user |
15+
| `dob` | Date of Birth of the user |
16+
| `email` | E-Mail ID of the user |
17+
| `pan` | Permanent Account Number of the user |
18+
| `ckyc_compliance` | Checks if the bank has carried out the CKYC compliance for the user |
19+
| `mobile` | Mobile number of the user |
20+
| `bank_names` | Name of the bank |
21+
| `bank_branch` | Branch of the bank |
22+
| `bank_account_number` | Bank account number of the user |
23+
| `bank_account_type` | Bank account type of the user |
24+
| `opening_date` | Date on which the bank account was opened |
25+
| `closing_balance` | Amount value of the account as of the lastest date |
26+
| `od_cc_limit` | The portion of the sanctioned limit that is available to be drawn |
27+
| `current_quarterly_average_eod_balance` | Average end of day balance for the current quarter |
28+
| `previous_quarterly_average_eod_balance` | Average end of day balance for previous quarter |
29+
| `end_of_month_balances` | Balances as on the end of the month |
30+
| `balances_on_10th` | Balances as on the 10th of the month |
31+
| `balances_on_20th` | Balances as on the 20th of the month |
32+
| `end_of_day_balances` | End of day balances for everyday of the month |
33+
| `average_end_of_day_balance` | Average of the end of day balances |
34+
| `maximum_end_of_day_balance` | Maximum of the end of day balances |
35+
| `total_credits` | Total number of credits to the user's accounts |
36+
| `total_credits_value` | Total amount credited to the user's account |
37+
| `total_debits` | Total number of debits to the user's account |
38+
| `total_debits_value` | Total amount debited from the user's account |
39+
| `top_10_credits` | Top 10 credit transactions of the user |
40+
| `top_10_debits` | Top 10 debit transactions of the user |
41+
| `quarterly_salary_average` | The 3 month average salary of the user |
42+
| `semi_yearly_salary_average` | The 6 month average salary of the user |
43+
| `yearly_salary_average` | The 12 month average salary of the user |
44+
| `cash_deposit_x_total_credit` | The monthly cash deposit to total credit amount ratio |
45+
| `cash_withdrawals` | 10 recent cash withdrawals |
46+
| `inward_cheque_bounce_count` | Total number of inward cheque bounces |
47+
| `outward_cheque_bounce_count` | Total number of outward cheque bounces |
48+
| `cheque_bounces` | Summary of cheque bounces |
49+
| `expenses_monthly_summary` | Detailed classification of the user's monthly expenses |
50+
| `inflows_monthly_summary` | Detailed classificaiton of the user's monthly incomes |
51+
52+
<WasPageHelpful />

‎content/data/insights/v1/notifications.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
sidebar_title: Notifications
3+
page_title: Setu Insights notifications
4+
order: 3
5+
visible_in_sidebar: true
6+
---
7+
8+
## Notifications
9+
10+
Notifications are webhooks from Setu that provide the data you requested.
11+
12+
The `base_url` is the server URL configured to receive notifications, which is the **Notification endpoint** you shared during template creation step.
13+
14+
<hr class="primary" />
15+
16+
#### Insights generated notification
17+
18+
This notification is used to communicate the generated insights which was requested by you in <a href="/data/insights/quickstart/api-integration#create-insight-report" target="_blank">
19+
Create Insight Report API</a>.
20+
21+
###### Notification payload
22+
23+
Setu will post this payload to your notification endpoint when Insights report is successfully generated.
24+
25+
<CodeBlockWithCopy language="json">
26+
{`{
27+
"type": "INSIGHT_STATUS_UPDATE",
28+
"timestamp": 2018-12-06T11:39:57.153Z,
29+
"reportId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
30+
"success": true,
31+
"data": {
32+
"status": "READY",
33+
"insights": {
34+
// ... insight_name : insight_value
35+
},
36+
"insight_errors": {}
37+
},
38+
"error": {}
39+
}`}
40+
</CodeBlockWithCopy>
41+
42+
<WasPageHelpful />

‎content/data/insights/v1/overview.mdx

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
sidebar_title: Overview
3+
page_title: Setu Insights overview
4+
order: 0
5+
visible_in_sidebar: true
6+
---
7+
8+
## What is Setu Insights?
9+
10+
Setu’s Insight API gives you actionable insights from a customer's bank statement about their income, expenditure and financial history.
11+
12+
The Setu Insights API consumes financial data uploaded via the Account Aggregator(AA) as well as external sources like PDF. The insights generated can be tailor made to fulfill your specific requirements, ranging from underwriting use cases, to personal finance management.
13+
14+
<Callout type="tip">
15+
Along with bank statement analysis, Setu Insights will support analysis of
16+
various data sources such as GST, ITR, Insurance etc., as and when these data
17+
types become available on AA.
18+
</Callout>
19+
20+
<br />
21+
22+
<Callout type="highlight">
23+
Setu Insights provides output in various formats such as XML, JSON, XLS.
24+
Output in the form of dashboard will be made available soon.
25+
</Callout>
26+
27+
<hr class="primary" />
28+
29+
### What can you do with this product?
30+
31+
With Setu Insights, you can analyse various financial statements like bank statements, GST returns, securities accounts etc. Some possible use-cases include—
32+
- **Income verification and underwriting**—Verify applicant income and assess creditworthiness by analyzing bank statements. Extract income sources, evaluate financial stability and streamline the loan approval process.
33+
- **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.
34+
- **Personal finance management and wealth management**—Empower individuals to manage personal finances effectively. Categorise transactions, generate spending reports and gain insights to set financial goals and make informed decisions. For wealth managers, access holistic financial data to offer personalized advice and tailored investment strategies.
35+
36+
<hr class="primary" />
37+
38+
### How does it work?
39+
40+
<img
41+
src="https://storage.googleapis.com/strapi-assets/latest/insights-basic-working-2/insights-basic-working-2.png"
42+
style={{ width: "85%", margin: "2em auto" }}
43+
/>
44+
45+
1. **Feed data**—Once your customer gives consent to access their financial data, the FIP shares the finance data with you (FIU), via the AA gateway. You feed this data into Setu Insights for analysis. Refer <a href="/data/account-aggregator/quickstart#quickstart-guide" target="_blank">AA docs</a> for a quick explanation of FIU, FIP, AA.
46+
47+
2. **Analyse financial data**—The raw data goes through a categorization model of Setu Insights and gets bucketed into various categories of incomes, expenses etc.
48+
49+
3. **Get reports**—Post analysis, the insights are provided to you in the format of your choice.
50+
51+
<NextPage
52+
info={{
53+
title: "Quickstart",
54+
description: "Get started with Setu Insights",
55+
slug: "/data/insights/quickstart",
56+
}}
57+
/>
58+
59+
<WasPageHelpful />

‎content/data/insights/v1/quickstart.mdx

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
sidebar_title: Quickstart
3+
page_title: Setu Insights quickstart
4+
order: 1
5+
visible_in_sidebar: true
6+
---
7+
8+
## Quickstart Guide
9+
10+
Here is a quick summary of steps to help you integrate with Setu’s Insights API. Before you start, there are some key terms that will be referred to periodically in the documentation—
11+
12+
- **FI Data block**—FI Data blocks are the data received from the FIP (Financial information provider), via the AA. Currently, we only support bank statement datablock.
13+
- **Template**—A template is a pre-configured format that determines the structure of the generated report, including which insights to generate. You can pick and choose exactly what insights should be added to a template, based on your needs. For example, if you only want to generate income and expense insights of a customer, the template can contain only those two insights.
14+
15+
<Callout type="tip">
16+
Please refer to the Account Aggregator's{" "}
17+
<a href="/data/account-aggregator/quickstart#quickstart-guide" target="_blank">
18+
quickstart guide
19+
</a>{" "}
20+
for key terms related to AA
21+
</Callout>
22+
23+
<hr className="primary" />
24+
25+
<br />
26+
27+
### Step 1—Template creation
28+
29+
You need to send in the below information to [insights@setu.co](mailto:insights@setu.co), for setting up your template.
30+
31+
| | |
32+
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
33+
| **FIU ID** | This can be obtained from your AA integration |
34+
| **Notification endpoint** | An endpoint where Setu will send you webhook notifications for events. See <a href="/data/insights/notifications" target="_blank">notifications</a>. |
35+
| **Template name** | Choose a suitable name, which helps you easily recognise this template |
36+
| **Insights required** | A list of required Insights. See the full list <a href="/data/insights/insights" target="_blank">**here**</a>. |
37+
| **Output format** | Format in which you need the output — currently only `JSON` is supported
38+
<br />
39+
40+
Setu will create a template for you and share a `templateID`, which can be used
41+
in the API calls.
42+
43+
<hr className="primary" />
44+
45+
### Step 2—Feed data
46+
47+
Once you have the financial data of a user, you can feed this data into Setu Insights as a FI Data block. A `dataId` is assigned to to every FI Data block that is created. Refer <a href="/data/insights/quickstart/api-integration" target="_blank">API integration</a> to integrate with Data ingestion APIs.
48+
49+
<hr className="primary" />
50+
51+
### Step 3—Generate insights
52+
53+
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.
54+
55+
An insight report is idenitified by a `reportId` and will be sent to you asynchronously on the notification URL you provide. You can also fetch a generated insight with the `reportId` at any point. Refer <a href="/data/insights/quickstart/api-integration" target="_blank">API integration</a> to integrate with Insight generation APIs.
56+
57+
<hr className="primary" />
58+
59+
## Test on Postman or integrate APIs
60+
61+
If you are getting started with the integration, we recommend that you familiarise yourself with setting up Postman and configuring **credentials**. If you have already completed this step, you can integrate with the Setu Insights APIs directly.
62+
63+
<Row>
64+
<Portion desktopSpan="half">
65+
<Card padding="small" shape="rounded">
66+
<p>ON POSTMAN</p>
67+
<a href="/data/insights/quickstart/postman" target="_blank">
68+
Set up Postman environment ->
69+
</a>
70+
</Card>
71+
</Portion>
72+
<Portion desktopSpan="half">
73+
<Card padding="small" shape="rounded">
74+
<p>FOR API INTEGRATION</p>
75+
<a
76+
href="/data/insights/quickstart/api-integration"
77+
target="_blank"
78+
>
79+
Start API integration ->
80+
</a>
81+
</Card>
82+
</Portion>
83+
</Row>
84+
85+
<WasPageHelpful />

0 commit comments

Comments
 (0)