Appendix

List of customer status#

ValueDescription
USER_CREATEDCustomer was created via server APIs
USER_TOKEN_ISSUEDAn access token has been issued to the Customer
USER_PROFILE_UPDATEDCustomer has updated the profile on app
USER_QUALIFIEDCustomer is qualified for hook offer
USER_DISQUALIFIEDCustomer is disqualified for hook offer

List of loan status#

Value
FRESH_LOAN
LOAN_DETAILS_SUBMITTED
KYC_PROCESSING
KYC_SUCCESS
KYC_REJECTED
LOAN_REJECTED
LOAN_APPROVED
BANK_FAILED
BANK_PROCESSING
BANK_ADDED
SIGN_AGREEMENT
DISBURSED
CANCELLED
CLOSED

List of user activities#

Event Description

Please note that the event description is always a string

ValueDescriptionEntityEvent Description String Example
user_createdUser was created against a customerIDSourcing Entity-
eligibility_calculatedLoan Eligibility was calculatedSourcing Entity25000.00
profile_updatedCustomer updated the profileCustomer-
bureau_consent_givenCustomer has given consent to fetch credit bureau dataCustomer-
pan_info_updatedCustomer submitted PAN numberCustomer-
bureau_auth_answer_submittedAnswers to additional questions asked by bureau were submittedCustomer-
user_disqualifiedThe Customer is disqualified from the loan. Same as Loan RejectedSystem-
user_qualifiedCustomer is qualified to move ahead and is shown hook offerSystem-
business_info_updatedCustomer submitted business informationCustomer-
gst_skippedGST Module was skipped by customerCustomer-
gstin_addedCustomer has added a GSTINCustomer-
gst_connect_attemptedGST Connect was attempted by user by entering GST Port credentialsCustomer-
gst_connect_failedGST Connect failedSystem-
gst_connectedGST successfully connectedSystem-
gst_completedGST module was completed by customerCustomer-
bank_connect_uploadedBank Statement was uploadedCustomer-
bank_connect_completedBank Statement was successfully analysedSystem-
bank_connect_failedBank Statement analysis failedSystem-
loan_application_createdCustomer clicked on Apply for Loan button & a loan application was createdCustomer-
form_updatedCustomer filled the loan application formCustomer-
address_updatedCustomer updated the addressCustomer-
business_address_updatedCustomer updated the business addressCustomer-
kyc_submittedKYC documents submitted by the CustomerCustomer-
kyc_verifiedKYC documents verifiedSourcing Entity Dashboard / System-
kyc_doc_rejectedAny KYC document was rejectedSourcing Entity Dashboard / System-
kyc_resubmittedKYC document re-submitted by CustomerCustomer-
lender_assignedA lender was assigned to finance the loan applicationSystem-
loan_approvedLoan was approved by a lenderSystem / Lender-
loan_rejectedLoan was rejected by a lenderSystem / Lender-
loan_offer_acceptedLoan offer was accepted by customerCustomer-
bank_details_addedCustomer updated bank details - acc number & IFSCCustomer-
bank_verification_failedBank could not be verifiedSystem-
bank_details_verifiedBank verification successfulSystem-
enach_startedE-Mandate journey startedCustomer-
enach_auth_successE-Mandate journey authorization completedSystem-
enach_auth_failedE-Mandate journey authorization failedSystem-
enach_completedE-Mandate journey completed after confirmation from bankSystem-
physical_mandate_downloadedPhysical Mandate form was downloadedCustomer-
physical_mandate_emailedPhysical Mandate form was emailedCustomer-
physical_mandate_submittedPhysical Mandate was submittedCustomer-
physical_mandate_approvedPhysical Mandate was approvedSystem-
loan_esignedCustomer esigned the loan agreementCustomer-
loan_disbursedLoan was disbursed by the lenderLender-
emi_paidEMI Paid by the customerCustomer / Sourcing Entity / System / Lender{"installmentNum": 1, "lastSource": "app", "lastPaidAmount": 1041.0}
emi_payment_initiatedEMI Payment initiated by the customerCustomer{"installmentNum": 1}
loan_signed_agreement_generatedSigned agreement PDF is generated for the customerSystem-
loan_closedLoan was closedSystem / Lender-
loan_cancelledLoan was cancelledSystem / Sourcing Entity-
late_fee_addedLate Fee was addedSystem{"installmentNum": 1, "lateCharge": 250.00}
late_fee_updatedLate Fee was updatedSystem{"installmentNum": 1, "lateCharge": 500.00}
emi_due_in_7_daysEMI is due in 7 daysSystem{"installmentNum": 1}
emi_due_in_3_daysEMI is due in 3 daysSystem{"installmentNum": 1}
emi_due_in_tomorrowEMI is due tomorrowSystem{"installmentNum": 1}
emi_overdueEMI is overdueSystem{"installmentNum": 1}
credit_line_createdCredit Line CreatedSystem{"limit": 100000.00}
credit_line_withdrewCredit Line Transaction Created / Withdrawl MadeCustomer{"amount": 2323.00, "txnID": "your_txn_id", "refID": "some_reference_id"}
credit_line_withdrew_failedCredit Line Transaction Withdrawl FailedCustomer{"amount": 2323.00, "txnID": "your_txn_id", "refID": "some_reference_id"}
credit_line_limit_updatedCredit Line Limit UpdatedSystem{"availableLimit": 50000.00}
credit_line_txn_confirmedCredit Line Transaction ConfirmedSourcing Entity{"txnID": "your_txn_id"}
credit_line_txn_cancelledCredit Line Transaction CancelledSourcing Entity{"txnID": "your_txn_id"}
credit_line_txn_disbursedCredit Line Transaction DisbursedSystem / Lender{"txnID": "your_txn_id"}
credit_line_txn_paidAll EMIs for Credit Line Transaction PaidSystem{"txnID": "your_txn_id"}
credit_line_txn_splittedCredit Line Transaction is splitted into different transactions based on order shipmentSourcing Entity{"txnID": "your_txn_id", "splitCount": 5}
Credit Line Specific Event Description

In case of credit line, event description formats will be as follows:

ActivityEvent Description Example
emi_paid{"installmentNum": 1, "txnID": "your_txn_id", "invoiceNo": "ABC-123", "lastSource": "app", "lastPaidAmount": 1041.0}
emi_payment_initiated{"installmentNum": 1, "txnID": "your_txn_id"}
late_fee_added{"installmentNum": 1, "lateCharge": 250, "txnID": "your_txn_id"}
late_fee_updated{"installmentNum": 1, "lateCharge": 500, "txnID": "your_txn_id"}
emi_due_in_7_days{"installmentNum": 1, "txnID": "your_txn_id"}
emi_due_in_3_days{"installmentNum": 1, "txnID": "your_txn_id"}
emi_due_tomorrow{"installmentNum": 1, "txnID": "your_txn_id"}
emi_overdue{"installmentNum": 1, "txnID": "your_txn_id"}

List of entity types#

IdentifierDescription
sourcing_entitySourcing Entity API
sourcing_entity_agentAn authorized agent of sourcing entity using dashboard.
customerThe customer / borrower
lenderLender - NBFC or Bank
lender_agentAn authorized agent of the lender
systemAutomated system