From 162acba1fec2ab252faadf3d7254f0e804dd59a0 Mon Sep 17 00:00:00 2001 From: rwnd Date: Tue, 19 Mar 2024 07:17:14 +0530 Subject: [PATCH 1/4] Add analytics and heartbeat APIs to documentation --- .../8-analytics_heartbeat_apis.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/9-loan_journey/8-analytics_heartbeat_apis.md diff --git a/docs/9-loan_journey/8-analytics_heartbeat_apis.md b/docs/9-loan_journey/8-analytics_heartbeat_apis.md new file mode 100644 index 0000000..49856ab --- /dev/null +++ b/docs/9-loan_journey/8-analytics_heartbeat_apis.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 8 +--- + +# Heartbeat APIs + +Lender and LA participants in the OCEN platform are expected to send Heartbeat APIs to the OCEN registry after every API call so that the registry can maintain the overall health of the loan product and the product network. + +## SubmitHearbeatEvent API + +| LOAN_REQ | Sent by LA after Create Loan Application Request API | +| LOAN_RESP | Sent by Lender after Create Loan Application Response API | +| CONSENT_REQ | Sent by LA after Consent Handle Request API | +| CONSENT_RESP | Sent by Lender after Consent Handle Response API | +| LOAN_GEN_OFFER_REQ | Sent by LA after Generate Offers Request API | +| LOAN_GEN_OFFER_RESP | Sent by Lender after Generate Offers Response API | +| LOAN_OFFER_REQ | Sent by LA after Set Offers Request API | +| LOAN_OFFER_RESP | Sent by Lender after Set Offers Response API | +| TRIGGER_KYC_REQ | Sent by LA after Trigger KYC Request API | +| KYC_RESP | Sent by Lender after Trigger KYC Response API | +| LOAN_ACCEPTANCE_REQ | Sent by LA after Trigger Loan Acceptance Request API | +| LOAN_ACCEPTANCE_RESP | Sent by Lender after Trigger Loan Acceptance Response API | +| LOAN_GRANT_REQ | Sent by LA after Grant Loan Request API | +| LOAN_GRANT_RESP | Sent by Lender after Grant Loan Response API | +| LOAN_REPAYMENT_REQ | Sent by LA after Set Repayment Plan Request API | +| LOAN_REPAYMENT_RESP | Sent by Lender after Set Repayment Plan Response API | +| LOAN_DISBURSMENT_REQ | Sent by LA after Set Disbursement Account Request API | +| LOAN_DISBURSMENT_RESP | Sent by Lender after Set Disbursement Account Response API | +| LOAN_TRIGGER_DISBURSMENT_REQ | Sent by LA after Trigger Disbursement Request API | +| LOAN_TRIGGER_DISBURSMENT_RESP | Sent by Lender after Trigger Disbursement Response API | +| LOAN_TRIGGER_REPAYMENT_REQ | Sent by LA after Trigger Repayment Request API | +| LOAN_TRIGGER_COLLECTION_REQ | Sent by Lender 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 API call ensures that the registry can maintain a high level metric on the amount disbursed by the platform. + +## 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. From b1391a1d88b52d5989c0704ad6c2c5c263cf5ea6 Mon Sep 17 00:00:00 2001 From: rwnd Date: Tue, 19 Mar 2024 07:58:17 +0530 Subject: [PATCH 2/4] Add analytics and heartbeat APIs to journey overview --- docs/9-loan_journey/1-loan_journey_overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/9-loan_journey/1-loan_journey_overview.md b/docs/9-loan_journey/1-loan_journey_overview.md index f207227..e2e53f7 100644 --- a/docs/9-loan_journey/1-loan_journey_overview.md +++ b/docs/9-loan_journey/1-loan_journey_overview.md @@ -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 | |-------|-------|---------| @@ -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 | From dcf9e6508e8d9bc0d3b1ae21b6f99004edecd479 Mon Sep 17 00:00:00 2001 From: rwnd Date: Tue, 19 Mar 2024 08:19:27 +0530 Subject: [PATCH 3/4] Fix table and description --- docs/9-loan_journey/8-analytics_heartbeat_apis.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/9-loan_journey/8-analytics_heartbeat_apis.md b/docs/9-loan_journey/8-analytics_heartbeat_apis.md index 49856ab..0d0d6b6 100644 --- a/docs/9-loan_journey/8-analytics_heartbeat_apis.md +++ b/docs/9-loan_journey/8-analytics_heartbeat_apis.md @@ -2,12 +2,16 @@ sidebar_position: 8 --- -# Heartbeat APIs +# 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 after every API call so that the registry can maintain the overall health of the loan product and the product network. -## SubmitHearbeatEvent API +### SubmitHearbeatEvent API +| Heartbeat Event Type | Caller and Event Timing | | +| ------------ | -------------------- | | LOAN_REQ | Sent by LA after Create Loan Application Request API | | LOAN_RESP | Sent by Lender after Create Loan Application Response API | | CONSENT_REQ | Sent by LA after Consent Handle Request API | @@ -31,9 +35,9 @@ Lender and LA participants in the OCEN platform are expected to send Heartbeat A | LOAN_TRIGGER_REPAYMENT_REQ | Sent by LA after Trigger Repayment Request API | | LOAN_TRIGGER_COLLECTION_REQ | Sent by Lender after Trigger Repayment Response API | -# Analytics APIs +## Analytics APIs Lenders in the OCEN platform are expected to send Analytics to the OCEN registry after every disbursement action made by them. This API call ensures that the registry can maintain a high level metric on the amount disbursed by the platform. -## SubmitLoanDisbursementMetrics API +### 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. From b7c93f51a4ab84c556f51a4269a9099753b5ac6e Mon Sep 17 00:00:00 2001 From: rwnd Date: Thu, 21 Mar 2024 19:55:54 +0530 Subject: [PATCH 4/4] Update based on CR feedback --- .../8-analytics_heartbeat_apis.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/9-loan_journey/8-analytics_heartbeat_apis.md b/docs/9-loan_journey/8-analytics_heartbeat_apis.md index 0d0d6b6..033c652 100644 --- a/docs/9-loan_journey/8-analytics_heartbeat_apis.md +++ b/docs/9-loan_journey/8-analytics_heartbeat_apis.md @@ -6,38 +6,38 @@ sidebar_position: 8 ## Heartbeat APIs -Lender and LA participants in the OCEN platform are expected to send Heartbeat APIs to the OCEN registry after every API call so that the registry can maintain the overall health of the loan product and the product network. +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 Event Timing | | +| Heartbeat Event Type | Caller and Callee Event Timing | | | ------------ | -------------------- | -| LOAN_REQ | Sent by LA after Create Loan Application Request API | -| LOAN_RESP | Sent by Lender after Create Loan Application Response API | -| CONSENT_REQ | Sent by LA after Consent Handle Request API | -| CONSENT_RESP | Sent by Lender after Consent Handle Response API | -| LOAN_GEN_OFFER_REQ | Sent by LA after Generate Offers Request API | -| LOAN_GEN_OFFER_RESP | Sent by Lender after Generate Offers Response API | -| LOAN_OFFER_REQ | Sent by LA after Set Offers Request API | -| LOAN_OFFER_RESP | Sent by Lender after Set Offers Response API | -| TRIGGER_KYC_REQ | Sent by LA after Trigger KYC Request API | -| KYC_RESP | Sent by Lender after Trigger KYC Response API | -| LOAN_ACCEPTANCE_REQ | Sent by LA after Trigger Loan Acceptance Request API | -| LOAN_ACCEPTANCE_RESP | Sent by Lender after Trigger Loan Acceptance Response API | -| LOAN_GRANT_REQ | Sent by LA after Grant Loan Request API | -| LOAN_GRANT_RESP | Sent by Lender after Grant Loan Response API | -| LOAN_REPAYMENT_REQ | Sent by LA after Set Repayment Plan Request API | -| LOAN_REPAYMENT_RESP | Sent by Lender after Set Repayment Plan Response API | -| LOAN_DISBURSMENT_REQ | Sent by LA after Set Disbursement Account Request API | -| LOAN_DISBURSMENT_RESP | Sent by Lender after Set Disbursement Account Response API | -| LOAN_TRIGGER_DISBURSMENT_REQ | Sent by LA after Trigger Disbursement Request API | -| LOAN_TRIGGER_DISBURSMENT_RESP | Sent by Lender after Trigger Disbursement Response API | -| LOAN_TRIGGER_REPAYMENT_REQ | Sent by LA after Trigger Repayment Request API | -| LOAN_TRIGGER_COLLECTION_REQ | Sent by Lender after Trigger Repayment Response API | +| 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 API call ensures that the registry can maintain a high level metric on the amount disbursed by the platform. +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.