Skip to main content

Loan Save / Loan Creation Version 1

POST Loan Save

This is the API for creating or saving loans. The Loan Save Api receives the loan once it has been generated at LOS and uses it to build the customer's loan portfolio for SynoFin LMS.

URL: {{base_url}}/loan-management/v1/loan/save

Run in Postman: Loan Save API

Request: 

Request Type: POST
Authorization: Bearer Token

Query Parameter:
Schema
Attributes
 Type Description Default Value / Master Value Mandatory
loan_application



dpd
 integer($int32) Dpd represents Due Past Days It should always be a round number No
email
 string Email represents applicant mail id
No
address
 string applicant address
No
currency
 integer($int32) The system or type of money that a particular country uses
No
tenure
 integer($int32)
minimum: 1		 The tenure in your loan is the time period between the disbursal of your loan and the last EMI payment that you make.
Yes
foir
 number($double) Fixed Obligation to Income Ratio
No
gender
 string Applicant gender Fetched From Masters No
industry
 string Type of industry master values (lists) No
customer


dob
 string($date-time) If DOB IS NULL THEN DOI ELSE DOB
Yes
remarks
 string remark
No
obligations
 [...] it contains obligation info about a customer like loan_amount,emi_amount, emis_paid,remaining_loan_balance details
No
email
 string

No
address
 line1


No
line2


No
pincode


No
city


No
state


No
country


No
type


No
residence_type


No
documents
 description
 string

No
document_url
 string S3 bucket url
No
is_verified
 string Document Identification number
No
applicant_type
 boolean whether document is verified
No
customer_name
 string

No
other_document_name
 string

No
document_type
 string

Yes (If, Document is uploaded)
document_status
 string

No
document_state
 string

No
receiving_date
 string($date-time)

No
document_file
 string

No
document_format
 string

No
loan_id
 integer($int64)

No
document_stage
 string

No
disbursal_stage
 string

No
document_department
 string

No
religion
 string religion of the customer
No
caste
 string caste of the customer
No
cibil integer($int32) cibil score of the customer

crif
 string It is one of the indicatior for the creditworthiness of a customer
No
industry
 string industry on which the customer is workng master values (lists) No
website
 string website of the customer
No
first_name
 string first name of the customer
Yes
last_name
 string last name of the customer
Yes
middle_name
 string middle name of the customer
No
gender_id
 integer
IF ID_Title = '1' Then 'Male' IF ID_Title = '2' Then 'Female' Else 'Others' No
category_id
 string its represent category like General, OBC, SC/ST of a customer
No
place_of_birth
 string place of birth of the customer
No
marital_status_id
 string marital status of the customer
Yes
country_code
 string phone country code of the customer
No
contact_person_name
 string name of the contact person of the customer
No
contact_person_mobile
 string mobile no. of the contact person of the customer
No
contact_person_email
 string email of the contact person of the customer
No
preferred_address
 string

No
phone_number
 type
 string Type of Phone number
Yes
phone
 string Phone Number
Yes
code
 string Country code
No
extn
 string Phone Extension
No
is_whatsapp_no
 boolean whether it is whatsapp number or not

FALSE

 No
related_people age
 integer($int32) Age of the person related to customer
No

dependants
 integer($int32)

No
remarks
 string

No
name
 string Name
No
address
 line1


No
type


No
dob
 string($date-time)

No
degree_id
 string

No
phone_number
 type string Type of Phone number
Yes
phone string Phone Number
Yes
code string Country code
No
extn string Phone Extension
No
is_whatsapp_no boolean whether it is whatsapp number or not FALSE No
occupation_id
 string Occupation
No
same_occupation
 boolean Whether same occupation as customer
No
living_with_him
 boolean Is related people living with thw customer
No
medical_condition
 string Medical condition
No
maiden_name
 string the original surname of a married woman who uses her husband's surname name after marriage.
No
people_type
 string

No
relation_id
 string Relation With customer
No
education_qualification_id
 string Education Qualification
No
customer_id


No
preferred_language


No
bank_details
 branch_name
 string name of bank branch
No
account_number
 string Account Number
No
id
 integer($int64)

No
bank_name
 string Bank Name
No
is_repayment_account
 boolean whether the bank account is repayment account
No
is_default_account
 boolean

No
branch_ifsc
 string Branch IFSC Code
No
bank_document
 [...] Bank Related Dcouments
No
nach_detail
 NachDetailRootRequestDTO{...}

No
umrn_no
 string

No
customer_name
 String Name of Customer
No
branch_code
 Strinf Account Branch Code
No
account_type
 string Type of Account
No
business_details
 landmark
 string landmark

phone
 string


msme
 boolean Ministry of Micro, Small & Medium Enterprises FALSE
ownership
 string


state
 string ownership of the business

district
 integer($int64) code of the state

city
 integer($int64) code of the district

earner
 integer($int64) code of the city

company_or_firm_name
 boolean check for identify the applicant is the earner or not

gross_monthly_income
 string name of the company or firm of the customer

total_work_experience
 integer($int64) gross monthly income of customer

major_occupation
 integer($int32) total work of the customer in the business

full_address
 boolean check whether the business is the major occupation of the customer or not

preferred_communication
 string full address of the businees

pin_code
 boolean preferred communication

total_expense
 string pincode of the business address

udyog_aadhar
 number($double) total expense of the business

loan_net_worth
 string Udyog Aadhaar Memorandum (UAM) is a single-page registration form under which, as an MSME registration, you can self-certify your entity's existence, bank details, promoter/ owner's Aadhaar details and other needed details

designation
 number($double) what is the net worth of the loan

monthly_purchase
 number($double) amount of purchase in a month

monthly_sale
 number($double) monthly sale of in the business

total_year_of_operation
 integer($int32) year of operation in business

occupation_type
 string type of occupation

institution_details
 [...] it contains instituition details of the customer like employerName, institution_name,registration_number etc

customer_type
 string It holds the info about the type like applicant, coapplicant, guarantor the customer belongs to

relationship_with_applicant
 string applicant releation with the customer

customer_relationship_id
 string it is the customer id from los

is_individual
 boolean


constitution_type
 string it holds the constitution type details like proprietorship,
partnership of a customer

authorized_signatory
 string


bureau_score
 string bureau score of a customer

registration_number
 string


registration_type
 string


sub_industry
 string it contains the sub industry info of the customer

partnership_percentage
 integer($int32)


msme_flag
 boolean


msme_subtype
 string


customer_category
 string it holds the info about customer category line indivisual or non-indivisual

commercial_bureau_score
 number($double) it contains the commercial bureau score

kyc_risk_categorization
 string


nach_detail
 NachDetailRootRequestDTO{...} it contails info about nach deails like umrn no, mandate id, status etc

payment
 PaymentToRequestDTO{...} It contains the payment info like account number, bank name , ifsc etc

insurance_data
 [...] it contains insurence info of the customer

equifax
 integer($int32) it represents the equifax score of the customer

education_qualification
 string it represents education qualification of the cutome

graduate
 number($double) total expense of the customer

total_expense
 string global id of the customer which is common in all bank and nbfc for a particular customer

global_customer_id
 integer($int32) number of dependent of the customer

number_of_dependents
 string A guardian may also be called a conservator when the role includes managing the finances of the child or adult.

guardian_name
 integer($int32) from how many number of year customer live in the current city

living_since_current_city
 integer($int32) number of month living at the current address

months_at_current_address
 integer($int32) number of months living at the current city

months_at_current_city
 integer($int32) number of years living at current address

repayment_contribution_amount
 integer($int32) number of years living at current city

repayment_contribution_percentage
 number($double) the amount of earnings remaining after all direct costs have been subtracted from revenue from the repayment amount

repayment_mode
 number($double) the percentage amount of earnings remaining after all direct costs have been subtracted from revenue from the repayment amount

isSubvention
 string it represents the repayment mode of the EMI FALSE
irr
 number($double) The internal rate of return (IRR) is a metric used in financial analysis to estimate the profitability of potential investments. null
source_application_number
 string Source application number generate in LOS null Yes
product_id
 string Type of product null Yes
branch_id
 string Bank branch id
master values (branch)
 0 No
dealer_id
 string Dealer Id
master values (dealer)
 null No
loan_application_id
 integer($int64) System auto generated auto_increament No
interest_rate
 number($double) Interest Rate 0 Yes
installment_frequency
 string Instalment Frequency means the period You have nominated to pay, this being monthly or yearly in advance. null No
sanctioned_amount
 number($double) The amount made available by the Lender for disbursal to the Borrower as Loan
Yes
disbursed_amount
 number($double) The agreed-upon amount is actually paid into the borrower's account and is available for use
Yes
paid_amount
 number($double) Paid amount

original_tenure
 integer($int32) Original tenure value

current_tenure
 integer($int32) Current tenure value

installment_computed_on
 string Installment computed on

sanction_date
 string($date-time) An official document issued by a lending organisation to customers stating that their loan is approved.
Yes
ltv_ratio
 number($double) Determines the maximum amount of a secured loan based on the market value of the asset pledged as collateral

tax_identification_number
 string A Taxpayer Identification Number is an identifying number used for tax purposes in the United States and in other countries under the Common Reporting Standard.

loan_amount
 number($double) Loan amount describes the total that one is authorized to borrow

loan_tenure
 integer($int32) The tenure in your loan is the time period between the disbursal of your loan and the last EMI payment that you make.

installments_paid
 integer($int32) Instalment payments refer to a customer paying a bill in small portions throughout a fixed period of time. Instalment payments are a payment plan arranged between the buyer and the seller. null
loan_marking
 [...]


installment_amount
 number($double) An installment loan is an agreement in which a loan is repaid over time through periodic payments. null
principal_outstanding
 number($double) Outstanding principal refers to the remaining amount of the original loan, plus any capitalized interest. 0
customer_name
 string Applicant name

phone_no
 string Applicant phone number

is_whatsapp_no
 boolean Applicant whatsapp number is store FALSE
advance_installment_count
 integer($int32) The thing being in case of advance emi, you downpay extra installment counts

advance_installment_amount
 number($double) Advance installment amount

total_installments
 integer($int32) Number of total installments null
is_priority_sector_lending_applicable
 boolean Priority sector lending is lending to those sectors of the economy which may not otherwise receive timely and adequate credit. This role is assigned by the Reserve Bank of India to the banks for providing a specified portion of the bank lending to few specific sectors like agriculture and allied activities, micro- and small enterprises, education, housing for the poor, and other low-income groups and weaker sections. FALSE
principle_outstanding
 number($double) Outstanding principal refers to the remaining amount of the original loan, plus any capitalized interest. 0
total_overdue
 number($double) Loan overdue refers to the loan amount that a customer fails to repay on time.

emi_due
 number($double) Emi got due 0
other_charges
 number($double) Other charges 0
disbursed_by
 string Loan disbursed by
Yes
source_application_identifier
 string Unique identifier number
Yes
product
 string Lending products are any of the wide variety of bilateral credit products that are offered by private or public banking firms and institutions. Product values store in master
scheme
 string A loan granted to a beneficiary by the Finance Partner that is aimed at financing a set of several pre-determined Projects under the Facility. Scheme value store in master Yes
loan_type
 string Type of Loan

loan_application_number
 string Loan Application number to identify loan

balance_principal
 number($double) The principal balance of your loan is the original amount you borrowed 0
interest_rate_monthly
 number($double) Interest rate monthly 0
customer_relationship_id
 string Applicant global id

customer_category
 string Applicant category

no_of_disbursement
 integer($int32) Number of disbursement

customer_id
 integer($int64) Applicant Id

product_code
 string Product code

scheme_code
 string Scheme code

loan_application_type
 string Loan application type

branch_code
 string Branch code

cibil_score
 integer($int32) CIBIL Score is a three-digit numeric summary of your credit history. The score is derived using the credit history found in the CIBIL Report

lending_rate
 number($double) Lending rate is the bank rate that usually meets the short- and medium-term financing needs of the private sector. This rate is normally differentiated according to creditworthiness of borrowers and objectives of financing.

scheme_lending_rate
 number($double)


branch_state
 string Branch State

branch_city
 string Branch City

emi_amount
 number($double) Emi Amount

customer_number
 string Applicant number

branch_zone
 string Branch zone

utilized_limit
 number($double) Utilized Limit

dsa_name
 string Direct Selling Agent. DSA's job is to find potential customers for the bank or the NBFC they represent.

unrealized_limit_amount
 number($double) Unrealised limit amount

applied_amount
 number($double) Actual applied amount by applicant for loan

branch_manager
 string Branch manager

sourcing_channel
 string Sourcing channel

risk_category
 string Risk category

sourcing_channel_type
 string Sourcing channel type

pd_location
 string Pending Revolving Loans means, at any time, the aggregate principal amount of all Revolving Loans requested in any Notice of Borrowing received by the Agent .

account_classification
 string Account classification Data Fetched From Masters
drawing_power
 number Drawing power is the limit upon which every borrower can withdraw the money within the cash credit limit.

lien_mark
 string Lien marking is the right given to the lender over a security to recover the money in case the credit given to the borrower is not repaid as per the terms agreed to. FALSE
lien_amount
 number($double) he amount of money that gets locked by the bank for a fixed period of time. 0
tos
 number($double) It is a type of document stating details about what a service provider is responsible for as well as user obligations that must be adhered to for continuation of the service. 0
debit_freeze
 string Frozen accounts do not permit any debit transactions. When an account is frozen, account holders cannot make any withdrawals, purchases, or transfers, but they may be able to continue to make deposits and transfer into it FALSE
total_freeze
 string
FALSE
pemi_count
 integer($int32) It is field to count to mantain the pre-emi count This field is used internally
loan_net_worth
 number($double) Net worth is the difference between the asset and the liability of an individual or a company

start_principle_recovery
 boolean Start of the principle recovery or not TRUE
caf_number
 string Customer appllication form

no_of_cheque_bounce
 integer($int64) Number of cheque bounce This field is used internally
dealer_code
 string It is a 14-digit numerical code provided by a bank with which your business has a current account.

advance_interest
 number($double) interest relating to a particular period of a loan, calculated or paid at the beginning of the period This field is used internally
advance_emi
 number($double) refers to the type of EMI payments where the first EMI payment is made in advance to the lender This field is used internally
advance_emi_payment_mode
 string Mod of advance emi payment mode This field is used internally
advance_interest_payment_mode
 string advance interest payment mode This field is used internally
total_moratorium_count
 integer($int32) count of total moratorium This field is used internally
next_emi_amount
 number($double) amount of the next emi This field is used internally
grace_period
 integer($int32) Grace period is a feature provided by banks or insurance companies so that customers can delay payment for a certain period of time after the due date

delinquency
 integer($int32) Delinquency means that you are behind on payments.

moratorium_period
 integer($int32) A moratorium period is a duration when the borrower doesn't have to make the home loan EMI payments

advance_amount_recovery_type
 string


total_nach_bounce_count
 integer($int32) count of the nach boune This field is used internally
total_count_of_repayment
 integer($int32) total count of repayment This field is used internally
whatsapp_no
 string whatsapp number This field is used internally
aggregated_ltv
 number($double) he ratio, in which the numerator is equal to the Aggregate Principal Balance and the denominator is equal to the Appraised Value of the Properties

overline_amount
 number($double) A loan amount in excess of a financial institution's legal lending limit to any one borrower in which the institution has enlisted the services of another lender to participate in the loan.

total_number_of_bounce_count



moratorium_type



moratorium_months



installment_plan
 string Hire-purchase Plan, in business, credit that is granted on condition of its repayment at regular intervals, or installments, over a specified period of time until paid in full

installment_mode
 string mode of installment paid

disbursal_status
 string status of disbursal

credit_manager_id
 integer($int32) id of credit manager

sourcing_rm
 integer($int32) sourcing rm

loan_status
 string status of loan

sourcing_rm_name
 string name of sourcing rm

sourcing_supervisor
 string


subvention_details
 SubventionDetails{...}


loan_documents description




document_url
 string S3 bucket url

document_value
 string Document Identification number

is_verified
 boolean whether document is verified

applicant_type
 string


customer_name
 string


other_document_name
 string


document_type
 string


document_status
 string


document_state
 string($date-time)


receiving_date
 string


document_file
 string


document_format
 integer($int64)


loan_id
 string


document_stage
 string


disbursal_stage
 string


document_department
 string


collateral description
 string description of collateral like collateral


address
 string address json

pincode
 integer($int32) pincode

remarks
 string remark

identifier
 string kind of collateral id

longitude
 number($double) longitude of collateral

latitude
 number($double) latitude of collateral

capacity
 number($double) capacity in case of collateral solar

status
 string status of collateral

marking
 string marking of collateral

country
 integer($int32) country code

region
 integer($int32) region kind of code

state
 integer($int32) state kind of code

city
 integer($int32) citty kind of code

district
 integer($int32) district kind of code

taluka
 integer($int32) taluka kind of code

village
 integer($int32) village kind of code

collateral_id
 integer($int64) collateral id

cersai_score
 number($double) cersai score

loan_id
 integer($int64) loan id

is_building_constructed
 boolean check whether building is constructed or not

built_up_area
 string The built-up area of a premise is measured from the external perimeter wall surfaces

carpet_area
 string The area of an apartment that can be covered by a carpet or the net usable area is known as the carpet area

age_of_property
 integer($int32) age of property

residual_age_of_property
 integer($int32) age of property like house such that for valuation it is valid for 100 yrs

plot_number
 string number of plot

seller_name
 string name of seller of collateral

present_registered_owner
 string name of present registered owner

tct_no
 integer($int64)


lot_no
 integer($int64) lot number in collateral

percentage_share
 integer($int32) Sharing Percentage means, as to a Partner, the percentage obtained by dividing the Units of such Partner by an amount equal to the total Units of all Partners.

is_property_registered_in_favour_of_borrower
 boolean check whether the property registered is in favor of borrower or not

registration_number
 string registration number of the collateral

agreement_value
 number($double) an amount that an insurance company agrees to insure a property for at the start of an insurance period, and that it will pay if the property is lost or destroyed

amenities_agreement_value
 number($double)


owner_name
 string name of the owner of the collateral

ownership_percentage_share
 integer($int32) percentage sharing of the owner in the collateral

policy_note_number
 string policy note number of collateral

insurance_company_name
 string the name of company providing you with financial coverage in the case of unexpected, bad events covered on your renters insurance or homeowners policy.

insurance_term
 string Term insurance provides coverage for the specified number of years, known as the policy term.

coverage_amount
 number($double)


premium_amount
 number($double) an amount paid periodically to the insurer by the insured for covering his risk

insurance_deviation_details
 string


cersai_txn_ref_no
 string cersai transaction refrence number

cersai_security_interest_id
 string cersai security interest id

cersai_no_of_borrowers
 integer($int32)


cersai_no_of_documents
 integer($int32)


cersai_no_of_third_parties
 integer($int32)


country_string
 string name of country

region_string
 string name of region

state_string
 string name of state

city_string
 string name of city

district_string
 string name of district

taluka_string
 string name of taluka

village_string
 string name of village

karat_value
 number($double) measuring unit of gold

gross_weight
 number($double) gross weight of gold in grms

net_weight
 number($double) net weight of gold in gms

rf_id
 string


collateral_product
 string type of collateral like invoice

installer_name
 string solar panel installer person name

installer_gstno
 string installer person gst number

installer_address
 string installer person address

installer_city
 string installer person city name

installer_state
 string installer person state name

installer_pincode
 integer($int32) installler person pincode

installer_district
 string installer person district

installer_id
 string intstaller person id

cost_of_asset
 number($double)


pv_module_model
 string pv module model nummber

pv_module_make
 string


inverter_model
 string In inverter type air conditioners, temperature is adjusted by changing motor speed without turning the motor ON and OFF

inverter_make
 string


asset_type
 string in case of vehicle loan asset type is vehicle like that

vehicle_type
 string it include two wheeler , four wheeler

manufacturer
 string for eg. : TW_MF_10 - SUZUKI

product
 string product is like two wheeler finace

model
 string model is like name of the vehicle

chasis_no
 string chasis number is Vehicle Identification Number(VIN) Details eg. :MB8DP12DJM8878946

dealer_name
 string name of the vehicle deeler person

dealer_address
 string dealer person address

dealer_city
 string dealer person city

dealer_state
 string dealer state

dealer_pincode
 integer($int32) dealer pincode

policy_cover_note_number
 string a temporary certificate of insurance issued by the Insurer before the issuance of a policy after the Insured has given a duly filled in proposal form and has paid the premium in full.

insurance_company
 string it basically refer to the insurance comapny in case of the vehicle loan

start_date_disburse_date
 string($date-time) the date of disbursal start

coverage_type
 string


ownership_status
 string ownership status in the collateral

installer_address_json
 string installer address json for store the address

vehicle_registration_no
 string vehicle registration number similar like VIN

engine_no
 string engine number of the vehicle

global_collateral_identifier
 string global collateral identifier number which is unique for a collateral

property_information
 string information about the property

land_type
 string There are various type of the land like agriculture, commercial, etc.

land_area
 number($double) area of land

collateral_type
 string It includes gold, solar, land, building, etc.

collateral_subtype
 string it include type of collateral like in case of collateral we can say building, land, etc.

repossession_status
 string there are two types of vehicle repossession: voluntary and involuntary

property_type
 string There are several type of the property like personal, private, public, etc.

nature_of_property
 string any physical or intangible entity that is owned by a person or jointly by a group of people

property_classification
 string Property Classification means assigning a grade to the property after assessment of its Reserve Value for the purposes of assigning a Premium to the property.

property_ownership
 string it is related to the owner of the property

property_purpose
 string property purpose include the terms like self-occupied, residential purpose, rented, etc.

market_value
 number($double) what is the current market value of the property

address_type
 string address type of the property like property , property_address, etc.

current_usage
 string current usage of the property like it is vacant or self-occupied, etc.

agreement_type
 string type of agrreement

sale_deed_date
 string($date-time) Date of sale means the date (normally shown on the instrument of conveyance or sale) that ownership of or title to real property, or control of the controlling interest in an entity that has a beneficial interest in real property, is delivered to the buyer/transferee in exchange for valuable consideration.

ownership_dates
 JsonNode{...} date of the ownership in collateral

disbursal_date
 string($date-time) date of amount disbursal

cersai_security_interest_creation_date
 string($date-time) According to the government's directives, financial institutions must register details of security interests created by them with CERSAI within 30 days of its creation.

collateral_document



insurance_start_date
 string($date-time) the day your insurance company will begin helping to pay for your expenses

insurance_end_date
 string($date-time) the date on which something such as a contract, right, or legal obligation ends

valuation_date_of_asset
 string($date-time) It is the date at which funds, assets, or money's value becomes effective

property_usage
 string the usage of the property

credit_manager
 integer($int32) Credit managers are responsible for overseeing the credit granting process for a company.

sourcing_branch
 integer($int32) sourcing branch

branch
 string branch

disbursal_date
 string($date-time) disbursal date

days_convention
 string A day-count convention is the system used on debt securities, such as bonds or swaps, to calculate the amount of accrued interest or the present value when the next coupon payment is less than a full coupon period away.

recovery_type
 string type of recovrery of loan

recovery_subType
 string there no many way of recovery money it comes under the recovery subtype

next_installment_date
 string($date-time) due date of next installment date

maturity_date
 string($date-time) date of the ideal closure of the loan

asset_classification
 string Asset classification, the system of assigning investments into groups or categories that have similar characteristics

tenure_convention
 string it is similar to tenure like convention type

spdc_details
 [...]


disbursal_details
 disbursal_number
 string remarks regarding disbursal

remarks
 number($double)


rate
 number($double) amount of disbused

disbursed_amount
 number($double) An enhancement amount, conventionally, is when a commercial producer pays money to a nonprofit theater to help subsidize a production.

enhanced_amount
 number($double) Reduced Amount means the greatest amount of Agreement Payments that can be paid that would not result in the imposition of the excise tax

reduced_amount
 number($double) the amount of saction which come from los side

sanctioned_amount
 number($double) an adjustment in the amounts payable under this Agreement (whether in the form of a lump sum or recurrent payment or increase in the Contract Price or otherwise) pursuant to clause 15.

adjusted_amount
 number($double) total disbursal amount

net_disbursal_amount
 string disbursal status

status
 string type of disbursal

disbursal_type
 number($double) amount to be paid

payment_amount
 number($double) amount pending as per disbursed amount

pending_amount
 [...] refer breakUpBaseDto

disbursal_breakup
 breakup_number
 string disbursal break up number

business_partner_name
 string name of business partner if any

business_partner_type
 string type of business partner

other_payables
 number($double) other payables

disbursal_amount
 number($double) amount of disbursed

paid_amount
 number($double) amount to be paid

payment_status
 string status of payment like paid , pending, etc

pending_amount
 number($double) amount which is pending from the nbfc side to disbursed

bank_name
 string name of the bank

ifsc_code
 string ifsc code of the respective bank

account_number
 string bank account number

instrument_type
 string type of instrument

disbursal_date
 string($date-time) date of disbursal

linked_loan_details



loan_charges
 original_amount
 number($double) total amount of all charges for a particular loan

paid_amount
 number($double) amount of charge paid out of original amount

charge_id
 string id of the charge

charge_rate
 number($double) rate apply on what rate

tax_amount
 number($double) amount of tax applied on the charges

status
 string it refers to the payment status

receivable_payable
 string receivable payable is a key which used internal to get data of charge

is_tax_applicable
 boolean check whether charges are tax applicable or not

pending_amount
 number($double) amount of charges which in pending

waived_amount
 number($double) amount which is waived by the nbfc

source_id
 string id of the source

tax_type
 string type of tax applied on particular charge

amount_without_tax
 number($double) amount without tax in the charges

charge_label
 string charge label

due_date
 string($date-time) upcoming payment date of the charges

transaction_date
 string($date-time) date of transaction of charges

receipts
 [...]


charges_receipt_mapping
 [...]


interest_start_date
 string($date-time) date of the interest start
Yes
repayment_start_date
 string($date-time) Start date of overpayment is fully paid back.

repayment_mode
 string mode of the repayment

agreement_date
 string($date-time) Date of Agreement means the effective date of the agreement which shall not be sooner than the date on which the agreement is executed and acknowledged by both the mortgagor and mortgagee.

login_date
 string($date-time) date at which loan is created

disbursal_maker_date
 string($date-time) date of disbursal request making

disbursal_author_date
 string($date-time) date of disbursal approved date

offer_amount
 integer($int32) amout to be offer

partial_tenure
 integer($int32) partial tenure of tthe loan

branch_hierarcy
 JsonNode{...}


state_head
 string state head

interviewer_details
 [...]


psl_applicable
 boolean psl flag for check whether psl applicable or not

is_repayment_contributed boolean flag to check whether repayment contribution is applied or not FALSE
interest_until integer($int64) interest till full disbursal

Base Schema
Customer Document Request DTO
Attribute Data Value Description Default Value Mandatory
description string
null optional
document_url string S3 bucket url null optional
document_value string Document Identification number null optional
is_verified boolean whether document is verified either true or false optional
applicant_type string
either applicant/coapplicant/gaurantor
  optional
customer_name string
null
document_type* string Type of document - aadhar, pan_card, etc. null mandatory
document_status string otc, pending, received, waiver null optional
document_state string origina, photocopy, etc. null optional
receiving_date string($date-time) Document Receiving Date null optional
document_file string  
 optional
document_format string  
 optional
loan_id integer($int64) Loan Id 0 optional
document_stage string 1st tranch, 2nd tranch, post disbursal. post sanction, etc. null optional
disbursal_stage string   null
document_department string audit, credit, leagal, operations null optional
Phone Number DTO
Attribute Data Value Description Default Value Mandatory
type* string Type of Phone number - mandatory
phone* string Phone Number - mandatory
code string Country code - optional
extn string Phone Extension - optional
is_whatsapp_no boolean whether it is whatsapp number or not FALSE optional
Related People Request DTO
Attribute Data Value Description Default Value Mandatory
age integer($int32) Age of the person related to customer null optional
dependants integer($int32)
null optional
remarks string
null optional
name string Name null optional
address ReferencesAddressDTO{...} Address null  optional
dob string($date-time)
null optional
degree_id string
null optional
phone_number [...] Phone Number
optional
occupation_id string Occupation null optional
same_occupation boolean Whether same occupation as customer null optional
living_with_him boolean Is related people living with thw customer null  optional
medical_condition string Medical condition null  optional
maiden_name string the original surname of a married woman who uses her husband's surname name after marriage. null optional
people_type string
null optional
relation_id string Relation With customer null
education_qualification_id string Education Qualification null optional





ReferencesAddressDTO

null optional
line1 string Complete Address null optional
type string Type of Address null optional
Bank Detail Request DTO
Attribute Data Value Description Default Value Mandatory
branch_name string name of bank branch bank branch name conatining less than 200 characters optional
account_number string Account Number accounting number containing less then 50 characters optional
id integer($int64)

optional
bank_name string Bank Name bank name conatining less than 200 characters optional
is_repayment_account boolean whether the bank account is repayment account true, false  optional
is_default_account boolean

optional
branch_ifsc string Branch IFSC Code Branch IFSC Code optional
bank_document [...] Bank Related Dcouments refer CustomerDocumentResponseDTO for rules to insert values optional
nach_detail NachDetailRootRequestDTO{...}
refer nach dto optional
umrn_no string

optional
account_type string Type of Account saving_account
current_account
cash_credit
over_draft_account
kcc_account
  optional
Nach Detail Root Request DTO
Attribute Data Value Description Default Value Mandatory
umrn string UMRN is a Unique Mandate Reference Number allocated to each new mandate created in NACH Debit   Optional
is_active boolean check wheather nach is active or not null Optional
status string status of the nach null Optional
mandate_type string type of mandate null Optional
remarks string remarks in case of nach null Optional
mandate_id string id of mandate null Optional
creation_date string($date-time) create date of nach null Optional
contribution_type string the amount of earnings remaining after all direct costs have been subtracted from revenue Enum
Fetched from Masters		 Optional
expiry_date string mandate expirty date null Optional
start_date string start date of the mandate null Optional
frequency string Frequency refers to the given time period on an intraday, daily, weekly, monthly, quarterly or yearly perspective. null Optional
mandate_amount_cap string there are different type of type of mandate cap amount based on the time limit null Optional
Payment To Request DTO

 

Attribute Data Value Description Default Value Mandatory
dob* string($date-time) date of birth of the customer null Mandatory
remarks string remarks of the payment null Optional
obligations [...]   [] Optional 
email [...]   [] Optional
address [...]   [] Optional 
documents [...]   [] Optional
religion string religion of the customer null Optional
caste string caste of the customer null Optional
cibil integer($int32) what is the cibil score of the customer null Optional
crif string crif of the customer null Optional
industry string An industry is a classification that refers to a group of companies that are related in terms of their primary business activities. null Optional
website string website null Optional
paymentFavour string name of account null Optional
accountNumber string account number null Optional
bankName string name of bank null Optional
ifsc string ifcs code of corresponding bank null Optional
branch string name of bank branch null Optional
accountType string type of account null Optional
categoryType string category type of customer null Optional
repaymentAccount string check whether customer account is repayment account or not null Optional
disbursalAccount string check whether customer account is disbursal account or not null Optional
first_name* string first name of the customer   Mandatory
last_name* string last name of the customer   Mandatory
middle_name string middle name of the custoomer   Optional
gender_id string gender id is refers to the gender of the customer null Optional
category_id string it refers to the category of the customer null Optional
place_of_birth string place of birth of customer null Optional
marital_status_id string maritial status of the customer   Optional
country_code string code of the country from which customer is belong null Optional
contact_person_name string name of the contact person name null Optional
contact_person_mobile string mobile number of the contact person null Optional
contact_person_email string email address of the contact person null Optional
preferred_address string preferred address of customer null Optional
phone_number [...]   json Optional
related_people [...]   {} Optional
customer_id integer($int64) id of customer auto increament Optional
preferred_language string preferred language null Optional
bank_details [...]   {}  Optional
business_details [...]   {}  Optional
institution_details [...]   {}  Optional
customer_type string customer type
either applicant/coapplicant/gaurantor
 Optional
relationship_with_applicant string what is the relation with the applicant null Optional
customer_relationship_id string id of customer with its relative used for mapping purpose null Optional
is_individual boolean check whether the loan is taken by the individual person or any institution TRUE Optional
constitution_type string it holds the constitution type details like proprietorship,
partnership of a customer		 null optional
authorized_signatory string   null optional
bureau_score string bureau score of a customer null optional
registration_number string   null optional
registration_type string registration tyep like listed non listed   optional
sub_industry string it contains the sub industry info of the customer null optional
partnership_percentage integer($int32) partnership percentage null optional
msme_flag boolean flag for check whether the laon is msme or not null optonal
msme_subtype string msme subtype null optional
customer_category string it holds the info about customer category line indivisual or non-indivisual null optional
commercial_bureau_score number($double) it contains the commercial bureau score null optional
kyc_risk_categorization string   null optional
nach_detail NachDetailRootRequestDTO{...} it contails info about nach deails like umrn no, mandate id, status etc [] optional
payment {
}		 It contains the payment info like account number, bank name , ifsc etc [] optional
insurance_data [...] it contains insurence info of the customer [] optional
equifax integer($int32) it represents the equifax score of the customer null optional
education_qualification string it represents education qualification of the cutome null optional
total_expense number($double) total expense of the customer null optional
global_customer_id string global id of the customer which is common in all bank and nbfc for a particular customer null optional
number_of_dependents integer($int32) number of dependent of the customer null optional
guardian_name string A guardian may also be called a conservator when the role includes managing the finances of the child or adult. null optional
living_since_current_city integer($int32) from how many number of year customer live in the current city null optional
months_at_current_address integer($int32) number of month living at the current address null optional
months_at_current_city integer($int32) number of months living at the current city null optional
years_at_current_address integer($int32) number of years living at current address null optional
years_at_current_city integer($int32) number of years living at current city null optional
repayment_contribution_amount number($double) the amount of earnings remaining after all direct costs have been subtracted from revenue from the repayment amount null optional
repayment_contribution_percentage number($double) the percentage amount of earnings remaining after all direct costs have been subtracted from revenue from the repayment amount null optional
repayment_mode string it represents the repayment mode of the EMI null optional
Business Request DTO
Attribute Data Value Description Default Value Mandatory
landmark string landmark null optional
phone string      
msme boolean Ministry of Micro, Small & Medium Enterprises FALSE optional
designation string   null optional
ownership string ownership of the business null optional
state integer($int64) code of the state null optional
district integer($int64) code of the district null optional
city integer($int64) code of the city null optional
earner boolean check for identify the applicant is the earner or not null optional
company_or_firm_name string name of the company or firm of the customer null optional
gross_monthly_income integer($int64) gross monthly income of customer null optional
total_work_experience integer($int32) total work of the customer in the business null optional
major_occupation boolean check whether the business is the major occupation of the customer or not null optional
full_address string full address of the businees null optional
preferred_communication boolean preferred communication null optional
pin_code string pincode of the business address null optional
total_expense number($double) total expense of the business null optional
udyog_aadhar string Udyog Aadhaar Memorandum (UAM) is a single-page registration form under which, as an MSME registration, you can self-certify your entity's existence, bank details, promoter/ owner's Aadhaar details and other needed details NULL optional
loan_net_worth number($double) what is the net worth of the loan null optional
monthly_purchase number($double) amount of purchase in a month NULL optional
monthly_sale number($double) monthly sale of in the business NULL optional
total_year_of_operation integer($int32) year of operation in business   optional
occupation_type string type of occupation null optional



Back to top