Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Domain Object List

NameDescription
AccountDetailsObject for capturing account details
AckAcknowledgement response for any Async request.
ActionRequiredDetails about additional actions expected from the user by the lender
AdditionalIdentifierAdditional identifier details for borrower/guarantor/applicant etc as the case might be
AddressDetails about the Address of the Borrower
ApplicantThis object captures the details of the person who is applying for the loan. Applicants can be different from the borrower.
BorrowerDetails about the Borrower, this identifies with verification status etc.
ChargeDetails about the penalty and processing charges for the loan
ChosenDisbursementObject capturing the chosen disbursement plan and disbursement account for the loan
ChosenRepaymentObject capturing the chosen repayment plan and active payment method for the loan
CollateralSecurity against which the loan is requested by the Borrower
CollateralsCollateral details presented by the user for the loan application. Beyond the scope of MVP, added this for future use-cases.
ConsentConsent details needed for raising a consent request
ContactDetailsThis object captures the contact details of the borrower/guarantor/applicant etc as the case might be
DisbursementObject capturing the disbursement plans and the disbursement account choices available
DisputeObject capturing the details of dispute and the suggested resolutions by the lender
DocumentsAll the data presented by the user to be used for granting loan will be classified as documents. Example - GST Invoices, Bank History, GST Summary, Swiggy Restaurant History
GuarantorsGuarantors for the loan application. Beyond the scope of MVP, added this for future use-cases.
All the data presented by the user to be used for granting loan will be classified as documents. Example - GST Invoices, Bank History, GST Summary, Swiggy Restaurant History
LenderThis object captures the details of the lender
LoanApplicationDetails of the loan application which is composed of borrower, collateral etc.
LoanTenureDetails about the tenure of the loan including duration and units
LoanTermsDetails of the loan like amount sanctioned, interest, tenure etc
LoanTermsHistoryDetails about how the loan parameters - amount, interest rate, tenure has changed over the course of loan
MetadataMetadata about each API request
OfferOffer will have the offer details like interest rate, tenure, minAmount, maxAmount etc
PartyObject for capturing the details of the parties who are associated with the collaterals
PaymentObject capturing the details of any kind of payment related to a loan
PaymentMethodObject capturing the details of payment method. Each method would have different set of attributes depending on the type
PaymentPlanDetails about the payment plans provided by the lender. Can be a disbursement plan or a repayment plan
ReferenceObject used for making pointing to a different entity in the request/response. For example: if the lender wants to refer a document from the Collateral section, this object should be populated with details of the document object `in payload
RejectionDetailsIf a lender rejects a loanRequest, it needs to send standardized rejection codes and user messages.
ResponseObject which indicates the successful completion of Request. If there are any business errors, they are captured inside response
TransactionObject capturing the details of individual transactions carried out on the loan. Includes both disbursement and repayment.
ValuationValuation details for the collateral. For example, in case of home loans, it will capture how much the home is valued at.