Skip to content

Heartbeat and Analytics documentation #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rwnd wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Heartbeat and Analytics documentation #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
162acba
Add analytics and heartbeat APIs to documentation
rwnd Mar 19, 2024
b1391a1
Add analytics and heartbeat APIs to journey overview
rwnd Mar 19, 2024
dcf9e65
Fix table and description
rwnd Mar 19, 2024
b7c93f5
Update based on CR feedback
rwnd Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/9-loan_journey/1-loan_journey_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The steps in the lending jounery can be categorized into the following stages.
* **Stages 3-5:** *Loan application prep* to *Offer selection to disbursement*, happen in sequence and depict the core loan application processing steps and involve the LA and Lender.
* **Stage 6:** *Post-disbursement*, varies for different products based on how collections are setup.
* **Stage 7:** *Partner APIs*, is the colection of APIs used by Lenders with other participants outside of LA.
* **Stage 8:** *Heartbeat and Analytics APIs*, is the colection of APIs that LA and Lender participants must call for the OCEN registry to maintain the overall network health.

| # | Stage | Explanation |
|-------|-------|---------|
Expand All @@ -21,3 +22,4 @@ The steps in the lending jounery can be categorized into the following stages.
| 5 | **Offer selection to disbursement** | APIs for offer selection, KYC, agreement, repayment and disbursement |
| 6 | **Post-disbursement** | APIs for steps post-disbursement. Eg: Repayment, Loan Details, Collections |
| 7 | **Partner APIs** | APIs involving partners (DDP, KYC, Collections, Disbursement partners) |
| 7 | **Heartbeat and Analytics APIs** | APIs for maintaining the health of the network |
43 changes: 43 additions & 0 deletions docs/9-loan_journey/8-analytics_heartbeat_apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 8
---

# Stage: Heartbeat and Analytics APIs

## Heartbeat APIs

Lender and LA participants in the OCEN platform are expected to send Heartbeat APIs to the OCEN registry upon sending as well as upon receipt of every API call so that the registry can maintain the overall health at the network level.

### SubmitHearbeatEvent API

| Heartbeat Event Type | Caller and Callee Event Timing | |
| ------------ | -------------------- |
| LOAN_REQ | Sent by both Caller and Callee after Create Loan Application Request API |
| LOAN_RESP | Sent by both Caller and Callee after Create Loan Application Response API |
| CONSENT_REQ | Sent by both Caller and Callee after Consent Handle Request API |
| CONSENT_RESP | Sent by both Caller and Callee after Consent Handle Response API |
| LOAN_GEN_OFFER_REQ | Sent by both Caller and Callee after Generate Offers Request API |
| LOAN_GEN_OFFER_RESP | Sent by both Caller and Callee after Generate Offers Response API |
| LOAN_OFFER_REQ | Sent by both Caller and Callee after Set Offers Request API |
| LOAN_OFFER_RESP | Sent by both Caller and Callee after Set Offers Response API |
| TRIGGER_KYC_REQ | Sent by both Caller and Callee after Trigger KYC Request API |
| KYC_RESP | Sent by both Caller and Callee after Trigger KYC Response API |
| LOAN_ACCEPTANCE_REQ | Sent by both Caller and Callee after Trigger Loan Acceptance Request API |
| LOAN_ACCEPTANCE_RESP | Sent by both Caller and Callee after Trigger Loan Acceptance Response API |
| LOAN_GRANT_REQ | Sent by both Caller and Callee after Grant Loan Request API |
| LOAN_GRANT_RESP | Sent by both Caller and Callee after Grant Loan Response API |
| LOAN_REPAYMENT_REQ | Sent by both Caller and Callee after Set Repayment Plan Request API |
| LOAN_REPAYMENT_RESP | Sent by both Caller and Callee after Set Repayment Plan Response API |
| LOAN_DISBURSMENT_REQ | Sent by both Caller and Callee after Set Disbursement Account Request API |
| LOAN_DISBURSMENT_RESP | Sent by both Caller and Callee after Set Disbursement Account Response API |
| LOAN_TRIGGER_DISBURSMENT_REQ | Sent by both Caller and Callee after Trigger Disbursement Request API |
| LOAN_TRIGGER_DISBURSMENT_RESP | Sent by both Caller and Callee after Trigger Disbursement Response API |
| LOAN_TRIGGER_REPAYMENT_REQ | Sent by both Caller and Callee after Trigger Repayment Request API |
| LOAN_TRIGGER_COLLECTION_REQ | Sent by both Caller and Callee after Trigger Repayment Response API |

## Analytics APIs

Lenders in the OCEN platform are expected to send Analytics to the OCEN registry after every disbursement action made by them. This will be further used to provide a real-time dashboard to RBI. This dashboard will only be accessible to RBI and there will be no identifiers saved along with the metric. The purpose of high level reporting is to reduce the compliance cost for the Lender and help the regulator with Real-time metrics.

### SubmitLoanDisbursementMetrics API
API call by Lender to the OCEN registry for sharing the disbursed amount, agreed tenure, and interest rate for the loan post-disbursement.