Skip to content
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

Heartbeat and Analytics documentation #38

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

Heartbeat and Analytics documentation #38

Changes from 1 commit
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
39 changes: 39 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,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.
rwnd marked this conversation as resolved.
Show resolved Hide resolved

## SubmitHearbeatEvent API

| LOAN_REQ | Sent by LA after Create Loan Application Request API |
rwnd marked this conversation as resolved.
Show resolved Hide resolved
| 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.
rwnd marked this conversation as resolved.
Show resolved Hide resolved

## 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.