documenter.getpostman.com
Open in
urlscan Pro
34.237.185.203
Public Scan
Submitted URL: https://documenter.getpostman.com/view/13594978/UVJkBDKL
Effective URL: https://documenter.getpostman.com/view/13594978/UVJkBDKL
Submission: On February 24 via manual from IN — Scanned from DE
Effective URL: https://documenter.getpostman.com/view/13594978/UVJkBDKL
Submission: On February 24 via manual from IN — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
Public
Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL
DREAMPLUG (CRED <> CRED AVENUE WORKFLOW)
* Introduction
* Integration Document
* Webhooks
* Validations
API
Dreamplug (Cred <> Cred Avenue Workflow)
INTEGRATION DOCUMENT
The following are the endpoints to be called during and pre/post disbursement
state of a loan.
AUTHENTICATION
Authentication details and host will be shared privately.
WORKFLOW
Create Loan is the initial endpoint to be called to create a loan. Loan will be
processed in the background and the status of loan will be provided through the
configured Webhook. However, the client can also poll the server via the Get
Loan Details endpoint to know the loan's status(Get Loan Details is rate
throttled and polling this API will be restricted). Loan's shall be considered
rejected if proper response is not available within 10minutes.
All other endpoints are self-explanatory and can be retried upto 3 times before
marking as failure.
ALLOWED LINKS
All Link attributes should contain
1. Accessible File Link URL which can be Public/Expiry URL/Whitelisted File
Server Link(Write to tech.colending@credavenue.com for obtaining our IP
address to whitelist)
2. File Link URL with Header Authentication (Header values should be shared
with tech.colending@credavenue.com)
ALLOWED FIELDS LENGTH
Data Type Max Length String 65,535 bytes Float 8 bytes Integer 4 bytes Date 10
characters
WEBHOOKS
Webhooks can be configured for the below events
1. Borrower status change
Callback Payload :
View More
{
"id": 148973,
"client_customer_id": "CA_B10",
"first_name": "Neeraj",
"last_name": "Chopra",
"mobile_number": [
"9876543210"
],
"email": [
"minato@gmail.com"
],
"status": "approved",
"dedupe_by_investor": "dedupe_skipped",
"kyc_status": "kyc_skipped",
"dedupe_approved_date": "null",
"dedupe_rejected_date": "null",
"kyc_completed_date": "null",
"created_at": "2022-01-20T05:10:51.344Z",
"updated_at": "2022-01-20T05:10:51.495Z"
}
Statuses : ['new', 'approved','rejected']
2. Loan status change
Callback Payload :
View More
{
"product_id": "",
"client_loan_id": "",
"principal_amount": "",
"interest_rate": "",
"tenure": "",
"tenure_frequency": "MONTHLY",
"cibil_score": "",
"purpose": "",
"repayment_frequency":"",
"number_of_repayments": "",
"status": "",
"principal_outstanding": "",
"reject_reason": ""
}
Statuses : ['new', 'approved', 'rejected', 'agreement_signed', 'dropped',
'disbursement_ready', 'disbursed', 'matured', 'partner_settled']
3. Loan disbursement details (Disbursed through razorpay)
Callback Payload:
View More
{
"client_loan_id":"",
"status":"borrower_disbursed",
"disbursed_date":"",
"utr_number":"",
"disbursement_type":"",
"payment_reversed": "TRUE/FALSE",
"disbursement_amount":"",
"investor_disbursed_amount": "",
"partner_disbursed_amount": "",
"differential_interest":"",
"investor_differential_interest":"",
"partner_differential_interest":"",
"differential_days":"",
"interest_start_date":"",
"investor_processing_fee":"",
"partner_processing_fee":"",
"investor_stamp_duty":"",
"partner_stamp_duty":"",
"investor_documentation_charges":"",
"partner_documentation_charges":""
}
Provide the following details to configure the webhooks
1. callback URL
2. authentication for the callback URL (header authentication)
VALIDATIONS
PAN
* Example: ABGPA1232P
* Sequence: First five digits will be alpha, next four will be Numerical and
again last single digit will be alpha
GSTIN
* Example: 33AAACT2727Q1ZV
* Sequence: First two digits is Numerical, Next is PAN sequence as specified
above, again thirteenth digit will be numerical, fourteenth digit is alpha,
last digit will be alpha or numerical
CIN
* Example: U65929TN2017PTC117196
* Sequence: First digit is Alpha, next 5 numeric digits, next two alpha, next
set of 4 numeric digits, Next 3 alpha, last 6 numeric digits
PASSPORT
* Example: A2096457
* Sequence: Total 8 digits, first digit is Alpha, remaining digits are
numerical
AADHAR NO
* The standard 12 digits numerical.
MOBILE NO
* Sequence: 10 numerical digits
IFSC CODE
* Example: PUNB0596600
* Sequence: First four alpha, next fifth digit is 0 (zero) always and last six
digit is alpha/numeric. Totally 11 digits.
PIN CODE
* 6 numerical digits
Contact Support: Name: API Support Email: support@colending.com
AUTHORIZATIONAPI Key
Key
<key>
Value
<value>
API
AUTHORIZATIONAPI Key
This folder is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
POST
Fetch KYC Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/kyc
FETCH CKYC SEARCH/DOWNLOAD
This API endpoint can be used to get the CKYC details.
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes client_customer_id
string true Customer id as per partners CRM/LOS CA_1234 [] kyc_type string true
ckyc/okyc/ekyc trigger to enable CKYC flow CA_1234 [] ckyc_id string false CKYC
ID of the customer CA_1234 [] date_of_birth string date false Date of birth in
DD/MM/YYYY, used for performing CKYC 1995-12-05 [] pan_number string false PAN
number of customer, used for performing CKYC BMMPH9018G [] mobile_number string
false Mobile number of the customer; 10 digits, used for performing CKYC
9876543210 [] permanent_pincode string false Permanent pincode of the customer,
used for performing CKYC 301301 [] passport_number string false Passport Number
of the customer, used for performing CKYC L4018345 [] driving_license_number
string false Driving License Number of customer, used for performing CKYC
TN0112345 [] voter_id_number string false VoterID Number of customer, used for
performing CKYC RTG2291234 [] ckyc_consent_date string date false Conscent date
for performing CKYC in YYYY-MM-DD 1995-12-05 [] ckyc_trigger_action string true
SEARCH/DOWNLOAD Trigger to initiate the CKYC search flow via CA SEARCH []
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
DREAMP_CRED_LIMI_P
(Required) Product Code given by CoLending
PATH VARIABLES
client_name
dreamplug
(Required) Name of the client
BODYraw
{
"client_customer_id": "CA_1234",
"kyc_type": "ckyc",
"ckyc_trigger_action": "download",
"pan_number": "HERPQ2613Y",
"date_of_birth": "1994-12-05",
"ckyc_id": "50020216232613"
}
200 Search
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/ca_pvtlt/api/v2/ckyc' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_customer_id": "CA_78910",
"kyc_type": "ckyc",
"ckyc_trigger_action": "search",
"pan_number": "DCVPM4582S",
"ckyc_id": "30028091745022"
}'
Example Response
200 OK
Body
Header(1)
View More
{
"RequestId": 12,
"CKYCStatus": "CKYCSuccess",
"ApplicationReferenceNumber": "appref123",
"Tags": "TW01",
"CKYCAvailable": "Yes",
"CKYCAccType": "Normal",
"CKYCID": 30028091745022,
"CKYCAge": 25,
"CKYCFatherName": "Mr jpga jpgs",
"CKYCPhotoImageType": "jpg",
POST
Create Borrower
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/borrowers
CREATE BORROWER
This API endpoint can be used to create a loan.
interest_rate: Rate of interest percent per annum
All link fields should have a valid accessible URL or "NA".
States should be in INDIAN_STATES array (refer at the end of the table).
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes customer_type string
false Individual / Corporate individual [] customer_category string false
Salaried, Self-Empolyed self_employed ["salaried", "self_employed_professional",
"self_employed", "others"] client_customer_id string true Customer id as per
partners CRM/LOS CA_1234 [] title string false Mr / Ms Mr [] first_name string
true First Name of the Customer Neeraj [] middle_name string false Middle Name
of the Customer Kumar [] last_name string false Last Name of the Customer Chopra
[] gender string false M / F / O m ["m", "f", "o"] date_of_birth string date
false Date of birth in YYYY-MM-DD 1995-12-05 [] age integer false Age in years
26 [] mobile_number integer true Mobile Number of the Customer (10 digits)
9876543210 [] phone_number integer false Contact Number of the Customer
4412345678 [] email string false Permanent Email id of the Customer
minato@gmail.com [] official_email_id string false Official Email ID of the
Customer minato_namikaze@credavenue.com [] place_of_birth string false Place of
birth of the Customer Chennai [] current_address string false Current address of
the applicant. Free flowing text 221B, Baker Street, Chennai [] current_village
string false Village in which applicant is currently residing. Free flowing for
now Vedaranyam [] current_city_tier string false tier1, tier2 etc. for the
current city tier2 ["tier1", "tier2", "tier3", "tier4"] current_city string
false City in which applicant is currently residing. Free flowing for now
Chennai [] current_district string false District in which applicant is
currently residing. Free flowing for now Chennai [] current_state string false
State in which applicant is currently residing. Free flowing for now nagaland
["jammu_kashmir", "himachal_pradesh", "punjab", "chandigarh", "uttaranchal",
"haryana", "delhi", "rajasthan", "uttar_pradesh", "bihar", "sikkim",
"arunachal_pradesh", "nagaland", "manipur", "mizoram", "tripura", "meghalaya",
"assam", "west_bengal", "jharkhand", "orissa", "chhattisgarh", "madhya_pradesh",
"gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra", "andhra_pradesh",
"karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu", "pondicherry",
"andaman_nicobar_islands", "telangana"] current_country string false Country in
which applicant is currently residing. Free flowing for now India []
current_pincode integer false Pincode of the current address 600089 []
residence_type_current_address string false rented / owned / leased owned
["rented", "owned", "leased"] years_of_stay_in_current_address integer false How
many years stayed in the current address 5 [] permanent_address string false
Permanent address of the customer. Free flowing for now 221B, Baker Street,
Chennai [] permanent_city string false Permanent city of the customer. Free
flowing for now Chennai [] permanent_city_tier string false tier1, tier2 etc.
for the permanent city tier3 ["tier1", "tier2", "tier3", "tier4"]
permanent_district string false Permanent district of the customer. Free flowing
for now Chennai [] permanent_state string false Permanent state of the customer.
Free flowing for now tripura ["jammu_kashmir", "himachal_pradesh", "punjab",
"chandigarh", "uttaranchal", "haryana", "delhi", "rajasthan", "uttar_pradesh",
"bihar", "sikkim", "arunachal_pradesh", "nagaland", "manipur", "mizoram",
"tripura", "meghalaya", "assam", "west_bengal", "jharkhand", "orissa",
"chhattisgarh", "madhya_pradesh", "gujarat", "daman_diu", "dadra_nagar_haveli",
"maharashtra", "andhra_pradesh", "karnataka", "goa", "lakshadweep", "kerala",
"tamil_nadu", "pondicherry", "andaman_nicobar_islands", "telangana"]
permanent_pincode integer false Permanent pincode of the customer. Free flowing
for now 600089 [] residence_type_permanent_address string false rented / owned /
leased owned ["rented", "owned", "leased"] years_of_stay_in_permanent_address
integer false How many years stayed in the permanent address 5 []
mailing_address string false Mailing address of the customer. Free flowing text
221B, Baker Street, Chennai [] marital_status string false married / unmarried
unmarried ["married", "unmarried"] religion string false Religion of customer.
Free flow text Hindu [] nationality string false Nationality of customer. Free
flow text indian [] caste string false Caste of customer. Free flow text indian
[] father_name string false Father name of customer. Free flow text Dan Kato []
mother_name string false Mother name of customer; Free flow text Tsunade Senju
[] spouse_name string false Spouse name of customer; Free flow text Kushina
Uzumaki [] education_qualification string false Educational Qualifications MBA
[] net_monthly_income number float false Monthly Income of the Customer (in
Rupees) 10000 [] annual_income number float false Annual income of the customer
in number (don’t convert into thousand/lacs etc) 120000 [] disposable_income
number float false Disposable income of the customer in number (don’t convert
into thousand/lacs etc) 120000 [] other_income number float false Other income
of the customer in number (don’t convert into thousand/lacs etc) 120000 []
no_of_dependants integer false Number of dependants 3 [] occupation string false
salaried / business / retired / self_employed and others salaried []
partner_score_on_the_customer number float false Partner score 3 []
politically_exposed string false Political Exposure of the Customer f []
income_source string false Cash / Cheque / Fund transfer Cash []
applicant_profession string false Profession of the Customer IT Consultant []
caution_negative_profile string false Is the customer categories as a negative
profile? t [] udyam_number string false Udyam Number of the Customer
UDYAM-UP-00-0123456 [] ckyc_complete string false This is a TRUE/FALSE flag
passed by client to indicate if the CKYC process for the applicant is complete
BMMPH9018G [] consent_ckyc_search string false Conscent TRUE/FALSE for
performing CKYC search BMMPH9018G [] consent_date_ckyc_search string false Date
on which consent was given to lender for performing CKYC search BMMPH9018G []
consent_ckyc_download string false Consent TRUE/FALSE for performing CKYC search
download BMMPH9018G [] consent_date_ckyc_download string false Date on which
conscent was given to lender for performing CKYC download BMMPH9018G []
okyc_complete string false This is a TRUE/FALSE flag passed by client to
indicate if the OKYC process for the applicant is complete BMMPH9018G []
pan_number string true PAN number of customer BMMPH9018G [] pan_number_link
array false PAN image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
pan_number_link_password string false PAN image password 12345678 []
form_60_link array false Form 60 If applicable
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
form_60_link_password string false Form 60 password If applicable 12345678 []
aadhar_number string false Aadhar number of customer 794065231234 []
aadhar_number_link array false Aadhar image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aadhar_number_link_password string false Aadhar image password 12345678 []
voter_id_number string false Voter ID Number of customer RTG2291234 []
voting_id_link array false Voter ID image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
voting_id_link_password string false Voter ID image password 12345678 []
driving_license_number string false Driving license number of customer TN0112345
[] driving_license_number_link array false Driving License image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
driving_license_number_link_password string false Driving license image password
12345678 [] driving_license_expiry_date string date false Expiry date of driving
license 2000-10-01 [] passport_number string false Passport number of customer
L4018345 [] passport_number_link array false Passport image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
passport_number_link_password string false Passport image password 12345678 []
video_image_link array false Video KYC of the Applicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_image_link_password string false Video KYC link password 12345678 []
video_kyc_detail object Refer table VideoKycDetail for attributes
{"profile_id":"AB12345","account_id":"AB12345","key":"abc@123","auditor":"Neeraj
Chopra","officer":"Neeraj Chopra"} other_kyc_number string false KYC Number of
the Customer ABC1234 [] other_kyc_link array false KYC Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_kyc_link_password string false KYC Image link password 12345678 []
rent_agreement_link array false KYC number of customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
rent_agreement_link_password string false Rent agreement link password 12345678
[] utility_bills_link array false Utility bills link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
utility_bills_link_password string false Utility bills link password 12345678 []
photo_link array false Photo Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
photo_link_password string false Photo Image password 12345678 [] employer_tier
string false tier1, tier2 etc. for the employer tier1 [] employer_category
string false Category of the employer Private [] employment_type string false
salaried / self_employed self_employed [] employment_details_name string false
Employer name. Free flowing text Credavenue [] employment_details_address string
false Office address. Free flowing text 221B, Baker Street, Chennai []
employment_details_years_of_experience number float false Applicant Number of
years in the current organization 5 [] employment_details_designation string
false Designation in current role, free flowing text Manager []
employement_vintage_current_organisation integer false No of Years in the same
Organisation 3 [] total_work_experience number float false Total years of
experience 5 [] payslip_link array false Last three month pay slip
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
payslip_link_password string false Last three month pay slip link password
12345678 [] tds_certificate_link array false Last Three Year TDS Certificate
Link ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tds_certificate_link_password string false Last Three Year TDS Certificate Link
12345678 [] udyam_number string false Udyam Number of the Customer
UDYAM-UP-00-0123456 [] pan_check string false Result of the pan check Success []
dedupe_status string false Result of the dedupe Failed [] bank_statement object
Refer table BankStatement for attributes
{"bank_statement_savings_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_savings_account_12_months_link_password":"12345678","bank_statement_current_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_current_account_12_months_link_password":"12345678","bank_signature_verification_form":"12345678","no_of_inward_chq_returns_savings_account":3,"no_of_outward_chq_returns_savings_account":4,"no_of_inward_chq_returns_current_account":5,"no_of_outward_chq_returns_current_account":6,"bank_account_type_for_assessment":"savings","perfios_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"perfios_link_password":"12345678","perfios_json_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"perfios_json_link_password":"12345678","perfios_json":["NA","NA"],"finbit_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"finbit_link_password":"12345678","finbit_json_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"finbit_json_link_password":"12345678","finbit_json":["NA","NA"],"abb":25000.0,"abd":10000.0,"credit_summation":"50000"}
name_of_bureau string false Cibil / Experian / Himark cibil [] bureau_vintage
integer false Vintage in the bureau. Number of years from the first trade line 3
[] bureau_score integer false Bureau Score 650 [] bureau_report_json_link array
false Document of the bureau
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_report_json_link_password string false Document of the bureau - Password
12345678 [] bureau_json_link array false Bureau Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_json_link_password string false Bureau Json placed in a link - Password
12345678 [] bureau_json array false Bureau Json response ["NA", "NA"]
commercial_bureau_score integer false CRIF score 330 []
commercial_bureau_score_link array false Commercial Bureau Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
commercial_bureau_score_link_password string false Commercial Bureau Document
Password 12345678 [] partner_score_on_the_customer_including_bureau_report
number float false Score Captured by the Partner 800 []
total_existing_obligations integer false Total Existing Obligations basis the
Bureau Report 25000 [] credit_card_limit integer false Total Credit Card Limit
basis the Bureau Report 30000 [] no_of_credit_cards integer false Total Number
of Credit Cards per Bureau Report 3 [] total_number_of_unsecured_loans integer
false Total Number of Unsecured Loans per Bureau Report 2 []
value_of_total_unsecured_loans number float false Total value of unsecured loans
20000 [] total_number_of_loans integer false Total Number of Loans per Bureau
Report 2 [] value_of_total_loans number float false Total value of loans 20000
[] number_of_enquiries_3months integer false Number of Enquiries in the Last 3
Months per Bureau Report 3 [] number_of_enquiries_6months integer false Number
of Enquiries in the Last 6 Months per Bureau Report 3 []
number_of_enquiries_12months integer false Number of Enquiries in the Last 12
Months per Bureau Report 4 []
number_of_writeoff_suitfiled_settled_in_the_last_12_months integer false Number
of Writeoff Suitfiled Settled in the Last 12 Months 4 []
max_dpd_tradeline_last_12months integer false Maximum DPD Tradeline in the Last
12 Months 6 [] max_overdue_tradeline integer false Maximum Overdue Tradeline 6
[] total_overdue_amount_in_last_12m number float false Total Overdue Amount in
the Last 12 Months 10000 [] amount_of_loan_settled_in_last_12m number float
false Loan Amount Settled in the Last 12 Months 25000 [] nature_of_loan_settled1
string false The nature of past loan settlement if any (Loan 1) - Settled/
Closed/ Written-off settled [] nature_of_loan_settled2 string false The nature
of past loan settlement if any (Loan 2) - Settled/ Closed/ Written-off closed []
total_emi_bounces integer false Total EMI Bounces 3 [] bounces_in_last_6m
integer false EMI Bounces in the Last 6 Months 3 [] bounces_in_last_12m integer
false EMI Bounces in the Last 12 Months 3 [] bureau_validity_date string date
false Validity of bureau report 1996-01-01 [] dpd_on_partner string date false
DPD on partner 90 [] max_dpd_tradeline_last_6months string date false Maximum
DPD tradeline in last 6 months 90 [] financial_data object false Refer table
FinancialData for attributes
{"annual_business_turnover":1000000.0,"annual_gross_profit":8000000.0,"annual_business_ebitda":5000000.0,"monthly_net_profit":14000.0,"annual_net_income":4000000,"annual_net_profit":30000000.0,"gst_annual_turnover":20000,"gst_return_year_1_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"gst_return_year_1_link_password":"12345678","gst_return_year_2_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"gst_return_year_2_link_password":"12345678","gst_return_year_3_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"gst_return_year_3_link_password":"12345678","it_return_year_1_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_1_link_password":"12345678","it_return_year_2_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_2_link_password":"12345678","it_return_year_3_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_3_link_password":"12345678","other_income_assesment_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_income_assesment_proof_link_password":"12345678","cam_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cam_link_password":"12345678","cfa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cfa_link_password":"12345678"}
abb_emi_ratio number float false Average Bank balance to EMI 2 [] dscr number
float false Debt Service Coverage Ratio 3 [] foir number float false Fixed
Obligations to Income Ratio 4 [] ltr number float false Loan Transfer Ratio 5 []
insr number float false INSR 6 [] eligibility_as_per_insr number float false
Eligibility as per INSR 10000 [] eligibility_as_per_foir number float false
Eligibility as per FOIR 20000 [] eligibility_as_per_ltv number float false
Eligibility as per LTV 30000 [] eligibility_loan_amount number float false
Eligibility Loan amount 40000 [] fcf integer false Free Cash Flows 24000 []
emi_obligations integer false Existing EMI obligations 20000 [] viability_ratio
number float false Net Assets/ Debt 2 [] idir_ratio number float false Net
Assets/ Debt 2 [] references array false Refer table References for attributes
[{"name":"Neeraj Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"},{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"}] limit_info object Refer table
LimitInfo for attributes
{"limit_id":10000.0,"total_approved_limit":10000.0,"limit_validity":"1996-01-01"}
VIDEOKYCDETAIL
Field Type Format Required Description Example Master Codes profile_id string
false Required if video KYC is done. Profile ID of the case as per the video KYC
vendor AB12345 [] account_id string false Required if video KYC is done. Account
ID of the case as per the video KYC vendor AB12345 [] key string false Required
if video KYC is done. Key as per the video KYC vendor abc@123 [] auditor string
false Name of the Video KYC Auditor Neeraj Chopra [] officer string false Name
of the Video KYC Officer Neeraj Chopra []
BANKSTATEMENT
View More
Field Type Format Required Description Example Master Codes
bank_statement_savings_account_12_months_link array false Savings bank account
statement for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_savings_account_12_months_link_password string false Savings bank
account statement for last 12 months Document Password 12345678 []
bank_statement_current_account_12_months_link array false Current account bank
details for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_current_account_12_months_link_password string false Current
account bank details for last 12 months Document Password 12345678 []
bank_signature_verification_form string false Bank signature verification
document 12345678 [] no_of_inward_chq_returns_savings_account integer false
Number of inward cheque returns in savings account 3 []
no_of_outward_chq_returns_savings_account integer false Number of outward cheque
returns in savings account 4 [] no_of_inward_chq_returns_current_account integer
false Number of inward cheque returns in current account 5 []
no_of_outward_chq_returns_current_account integer false Number of outward cheque
returns in current account 6 [] bank_account_type_for_assessment string false
Savings / Current / Overdraft / CC savings [] perfios_link array false Perfios
report in form of document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
perfios_link_password string false Perfios report in form of document - password
12345678 [] perfios_json_link array false Perfios Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
perfios_json_link_password string false Perfios Json placed in a link - password
12345678 [] perfios_json array false Perfios Json response ["NA", "NA"]
finbit_link array false Finbit report in form of document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
finbit_link_password string false Finbit report in form of document - Password
12345678 [] finbit_json_link array false Finbit Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
finbit_json_link_password string false FINBIT Json placed in a link - Password
12345678 [] finbit_json array false FINBIT Json response ["NA", "NA"] abb number
float false Average Bank Balance maintaiend on the EMI dates (Calculated by the
Originator for the Last 12 Months) 25000 [] abd number float false Average
Monthly Bank Deposits for the Last 12 Months 10000 [] credit_summation string
false Sum of all the credits in the bank statement 50000 []
FINANCIALDATA
View More
Field Type Format Required Description Example Master Codes
annual_business_turnover number float true Annual Business Turnover (in Rupees)
1000000 [] annual_gross_profit number float true Annual Gross Profit (in Rupees)
8000000 [] annual_business_ebitda number float false Annual Business EBITDA (in
Rupees) 5000000 [] monthly_net_profit number float true Monthly Net Profit (in
Rupees) 14000 [] annual_net_income integer false Annual Net Income 4000000 []
annual_net_profit number float false Net Profit After Tax (in Rupees) 30000000
[] gst_annual_turnover integer false GST Annual Turnover 20000 []
gst_return_year_1_link array false GST return image for last year
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
gst_return_year_1_link_password string false GST return image password for last
year 12345678 [] gst_return_year_2_link array false GST return image for last
year -1
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
gst_return_year_2_link_password string false GST return image password for last
year -1 12345678 [] gst_return_year_3_link array false GST return image for last
year -2
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
gst_return_year_3_link_password string false GST return image password for last
year -2 12345678 [] it_return_year_1_link array false IT return image for last
year ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_1_link_password string false IT return image password for last
year 12345678 [] it_return_year_2_link array false IT return image for last year
-1 ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_2_link_password string false IT return image for last year -1
12345678 [] it_return_year_3_link array false IT return image for last year - 2
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_3_link_password string false IT return image for last year - 2
12345678 [] other_income_assesment_proof_link array false Image of other bills
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_income_assesment_proof_link_password string false Image password of other
bills 12345678 [] cam_link array false CAM Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
cam_link_password string false CAM Document Password 12345678 [] cfa_link array
false CFA Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
cfa_link_password string false CFA Document Password 12345678 []
REFERENCES
Field Type Format Required Description Example Master Codes name string false
Name of reference Neeraj Chopra [] address string false Address details of
reference 221B, Baker Street, Chennai [] pincode string false Pincode of
reference address 600001 [] phone string false Phone number of reference
9876543210 []
LIMITINFO
Field Type Format Required Description Example Master Codes limit_id number
float true Limit ID for the borrower 10000 [] total_approved_limit number float
true Total approved limit for the borrower 10000 [] limit_validity string date
true Expiry date for the Limit 1996-01-01 []
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 422 Unprocessable Entity
* Client Loan Already Taken
* Product Not Found
* Document not found/accessible
500 Internal Server Error Error occurred in the backend
INDIAN STATES
* jammu_kashmir
* himachal_pradesh
* punjab
* chandigarh
* uttaranchal
* haryana
* delhi
* rajasthan
* uttar_pradesh
* bihar
* sikkim
* arunachal_pradesh
* nagaland
* manipur
* mizoram
* tripura
* meghalaya
* assam
* west_bengal
* jharkhand
* orissa
* chhattisgarh
* madhya_pradesh
* gujarat
* daman_diu
* dadra_nagar_haveli
* maharashtra
* andhra_pradesh
* karnataka
* goa
* lakshadweep
* kerala
* tamil_nadu
* pondicherry
* andaman_nicobar_islands
* telangana
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
BODYraw
View More
{
"customer_type": "individual",
"customer_category": "self_employed",
"client_customer_id": "CRED_12346",
"title": "Mr",
"first_name": "Kamalraj",
"middle_name": "-",
"last_name": "Matheswaran",
"gender": "m",
"date_of_birth": "1995-12-05",
"age": 26,
201 Created
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/ca_pvtlt/api/v2/borrowers' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"customer_type": "individual",
"customer_category": "self_employed",
"client_customer_id": "CA_1234",
"product ID": "CA_1234",
"title": "Mr",
"first_name": "Neeraj",
"middle_name": "Kumar",
Example Response
201 Created
Body
Header(1)
{
"client_customer_id": "AB001",
"status": "new"
}
GET
Get Borrower Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/borrowers/:borrower_id
GET BORROWER DETAILS
This API endpoint can be used to get the Borrower details.
RESPONSE CODES
Code Message Reason 200 OK Success 401 Unauthorized Invalid API Key 404 Not
found Loan not found 500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
borrower_id
CA_12233
(Required) Client Customer ID as provided during Borrower creation
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/ca_pvtlt/api/v2/borrowers/AB001' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
View More
{
"id": 148973,
"client_customer_id": "AB001",
"first_name": "Neeraj",
"last_name": "Chopra",
"mobile_number": [
"9876543210"
],
"email": [
"minato@gmail.com"
],
PUT
Update Borrower
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/borrowers/:borrower_id
UPDATE BORROWER API
This endpoint can be used to update the borrower details.
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes customer_type string
true Individual / Corporate individual [] customer_category string false
Salaried, Self-Empolyed salaried ["salaried", "self_employed_professional",
"self_employed", "others"] client_customer_id string true Customer id as per
partners CRM/LOS CA_1234 [] title string false Mr / Ms Mr [] first_name string
true First Name of the Customer Neeraj [] middle_name string false Middle Name
of the Customer Kumar [] last_name string false Last Name of the Customer Chopra
[] gender string true M / F / O o ["m", "f", "o"] date_of_birth string date true
Date of birth in YYYY-MM-DD 1995-12-05 [] age integer false Age in years 26 []
mobile_number integer true Mobile Number of the Customer (10 digits) 9876543210
[] phone_number integer false Contact Number of the Customer 4412345678 [] email
string true Permanent Email id of the Customer minato@gmail.com []
official_email_id string false Official Email ID of the Customer
minato_namikaze@credavenue.com [] place_of_birth string false Place of birth of
the Customer Chennai [] current_address string false Current address of the
applicant. Free flowing text 221B, Baker Street, Chennai [] current_village
string false Village in which applicant is currently residing. Free flowing for
now Vedaranyam [] current_city_tier string false tier1, tier2 etc. for the
current city tier4 ["tier1", "tier2", "tier3", "tier4"] current_city string
false City in which applicant is currently residing. Free flowing for now
Chennai [] current_district string false District in which applicant is
currently residing. Free flowing for now Chennai [] current_state string false
State in which applicant is currently residing. Free flowing for now
uttar_pradesh ["jammu_kashmir", "himachal_pradesh", "punjab", "chandigarh",
"uttaranchal", "haryana", "delhi", "rajasthan", "uttar_pradesh", "bihar",
"sikkim", "arunachal_pradesh", "nagaland", "manipur", "mizoram", "tripura",
"meghalaya", "assam", "west_bengal", "jharkhand", "orissa", "chhattisgarh",
"madhya_pradesh", "gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra",
"andhra_pradesh", "karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu",
"pondicherry", "andaman_nicobar_islands", "telangana"] current_country string
false Country in which applicant is currently residing. Free flowing for now
India [] current_pincode integer false Pincode of the current address 600089 []
residence_type_current_address string false rented / owned / leased rented
["rented", "owned", "leased"] years_of_stay_in_current_address integer false How
many years stayed in the current address 5 [] permanent_address string true
Permanent address of the customer. Free flowing for now 221B, Baker Street,
Chennai [] permanent_city string true Permanent city of the customer. Free
flowing for now Chennai [] permanent_city_tier string false tier1, tier2 etc.
for the permanent city tier2 ["tier1", "tier2", "tier3", "tier4"]
permanent_district string true Permanent district of the customer. Free flowing
for now Chennai [] permanent_state string true Permanent state of the customer.
Free flowing for now goa ["jammu_kashmir", "himachal_pradesh", "punjab",
"chandigarh", "uttaranchal", "haryana", "delhi", "rajasthan", "uttar_pradesh",
"bihar", "sikkim", "arunachal_pradesh", "nagaland", "manipur", "mizoram",
"tripura", "meghalaya", "assam", "west_bengal", "jharkhand", "orissa",
"chhattisgarh", "madhya_pradesh", "gujarat", "daman_diu", "dadra_nagar_haveli",
"maharashtra", "andhra_pradesh", "karnataka", "goa", "lakshadweep", "kerala",
"tamil_nadu", "pondicherry", "andaman_nicobar_islands", "telangana"]
permanent_pincode integer true Permanent pincode of the customer. Free flowing
for now 600089 [] residence_type_permanent_address string false rented / owned /
leased owned ["rented", "owned", "leased"] years_of_stay_in_permanent_address
integer false How many years stayed in the permanent address 5 []
mailing_address string false Mailing address of the customer. Free flowing text
221B, Baker Street, Chennai [] marital_status string false married / unmarried
unmarried ["married", "unmarried"] religion string false Religion of customer.
Free flow text Hindu [] nationality string true Nationality of customer. Free
flow text indian [] caste string false Caste of customer. Free flow text indian
[] father_name string false Father name of customer. Free flow text Dan Kato []
mother_name string false Mother name of customer; Free flow text Tsunade Senju
[] spouse_name string false Spouse name of customer; Free flow text Kushina
Uzumaki [] education_qualification string false Educational Qualifications MBA
[] net_monthly_income number float true Monthly Income of the Customer (in
Rupees) 10000 [] annual_income number float false Annual income of the customer
in number (don’t convert into thousand/lacs etc) 120000 [] disposable_income
number float false Disposable income of the customer in number (don’t convert
into thousand/lacs etc) 120000 [] other_income number float false Other income
of the customer in number (don’t convert into thousand/lacs etc) 120000 []
no_of_dependants integer false Number of dependants 3 [] occupation string false
salaried / business / retired / self_employed and others salaried []
partner_score_on_the_customer number float false Partner score 3 []
politically_exposed string false Political Exposure of the Customer false []
income_source string false Cash / Cheque / Fund transfer Cash []
applicant_profession string false Profession of the Customer IT Consultant []
caution_negative_profile string false Is the customer categories as a negative
profile? t [] udyam_number string false Udyam Number of the Customer
UDYAM-UP-00-0123456 [] ckyc_complete string true This is a TRUE/FALSE flag
passed by client to indicate if the CKYC process for the applicant is complete
BMMPH9018G [] consent_ckyc_search string false Conscent TRUE/FALSE for
performing CKYC search BMMPH9018G [] consent_date_ckyc_search string false Date
on which consent was given to lender for performing CKYC search BMMPH9018G []
consent_ckyc_download string false Consent TRUE/FALSE for performing CKYC search
download BMMPH9018G [] consent_date_ckyc_download string false Date on which
conscent was given to lender for performing CKYC download BMMPH9018G []
okyc_complete string false This is a TRUE/FALSE flag passed by client to
indicate if the OKYC process for the applicant is complete BMMPH9018G []
pan_number string true PAN number of customer BMMPH9018G [] pan_number_link
array true PAN image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
pan_number_link_password string false PAN image password 12345678 []
form_60_link array false Form 60 If applicable
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
form_60_link_password string false Form 60 password If applicable 12345678 []
aadhar_number string false Aadhar number of customer 794065231234 []
aadhar_number_link array false Aadhar image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aadhar_number_link_password string false Aadhar image password 12345678 []
voter_id_number string false Voter ID Number of customer RTG2291234 []
voting_id_link array false Voter ID image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
voting_id_link_password string false Voter ID image password 12345678 []
driving_license_number string false Driving license number of customer TN0112345
[] driving_license_number_link array false Driving License image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
driving_license_number_link_password string false Driving license image password
12345678 [] driving_license_expiry_date string date false Expiry date of driving
license 2000-10-01 [] passport_number string false Passport number of customer
L4018345 [] passport_number_link array false Passport image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
passport_number_link_password string false Passport image password 12345678 []
video_image_link array false Video KYC of the Applicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_image_link_password string false Video KYC link password 12345678 []
video_kyc_detail object Refer table VideoKycDetail for attributes
{"profile_id":"AB12345","account_id":"AB12345","key":"abc@123","auditor":"Neeraj
Chopra","officer":"Neeraj Chopra"} other_kyc_number string false KYC Number of
the Customer ABC1234 [] other_kyc_link array false KYC Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_kyc_link_password string false KYC Image link password 12345678 []
rent_agreement_link array false KYC number of customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
rent_agreement_link_password string false Rent agreement link password 12345678
[] utility_bills_link array false Utility bills link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
utility_bills_link_password string false Utility bills link password 12345678 []
photo_link array false Photo Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
photo_link_password string false Photo Image password 12345678 [] employer_tier
string false tier1, tier2 etc. for the employer tier1 [] employer_category
string false Category of the employer Private [] employment_type string false
salaried / self_employed self_employed [] employment_details_name string false
Employer name. Free flowing text Credavenue [] employment_details_address string
false Office address. Free flowing text 221B, Baker Street, Chennai []
employment_details_years_of_experience number float false Applicant Number of
years in the current organization 5 [] employment_details_designation string
false Designation in current role, free flowing text Manager []
employement_vintage_current_organisation integer false No of Years in the same
Organisation 3 [] total_work_experience number float false Total years of
experience 5 [] payslip_link array false Last three month pay slip
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
payslip_link_password string false Last three month pay slip link password
12345678 [] tds_certificate_link array false Last Three Year TDS Certificate
Link ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tds_certificate_link_password string false Last Three Year TDS Certificate Link
12345678 [] udyam_number string false Udyam Number of the Customer
UDYAM-UP-00-0123456 [] pan_check string false Result of the pan check Success []
dedupe_status string false Result of the dedupe Failed [] bank_statement object
Refer table BankStatement for attributes
{"bank_statement_savings_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_savings_account_12_months_link_password":"12345678","bank_statement_current_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_current_account_12_months_link_password":"12345678","bank_signature_verification_form":"12345678","no_of_inward_chq_returns_savings_account":3,"no_of_outward_chq_returns_savings_account":4,"no_of_inward_chq_returns_current_account":5,"no_of_outward_chq_returns_current_account":6,"bank_account_type_for_assessment":"savings","perfios_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"perfios_link_password":"12345678","perfios_json_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"perfios_json_link_password":"12345678","perfios_json":["NA","NA"],"finbit_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"finbit_link_password":"12345678","finbit_json_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"finbit_json_link_password":"12345678","finbit_json":["NA","NA"],"abb":25000.0,"abd":10000.0,"credit_summation":"50000"}
name_of_bureau string true Cibil / Experian / Himark cibil [] bureau_vintage
integer false Vintage in the bureau. Number of years from the first trade line 3
[] bureau_score integer true Bureau Score 650 [] bureau_report_json_link array
true Document of the bureau
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_report_json_link_password string false Document of the bureau - Password
12345678 [] bureau_json_link array false Bureau Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_json_link_password string false Bureau Json placed in a link - Password
12345678 [] bureau_json array false Bureau Json response ["NA", "NA"]
commercial_bureau_score integer false CRIF score 330 []
commercial_bureau_score_link array false Commercial Bureau Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
commercial_bureau_score_link_password string false Commercial Bureau Document
Password 12345678 [] partner_score_on_the_customer_including_bureau_report
number float false Score Captured by the Partner 800 []
total_existing_obligations integer false Total Existing Obligations basis the
Bureau Report 25000 [] credit_card_limit integer false Total Credit Card Limit
basis the Bureau Report 30000 [] no_of_credit_cards integer false Total Number
of Credit Cards per Bureau Report 3 [] total_number_of_unsecured_loans integer
false Total Number of Unsecured Loans per Bureau Report 2 []
value_of_total_unsecured_loans number float false Total value of unsecured loans
20000 [] total_number_of_loans integer false Total Number of Loans per Bureau
Report 2 [] value_of_total_loans number float false Total value of loans 20000
[] number_of_enquiries_3months integer false Number of Enquiries in the Last 3
Months per Bureau Report 3 [] number_of_enquiries_6months integer false Number
of Enquiries in the Last 6 Months per Bureau Report 3 []
number_of_enquiries_12months integer false Number of Enquiries in the Last 12
Months per Bureau Report 4 []
number_of_writeoff_suitfiled_settled_in_the_last_12_months integer false Number
of Writeoff Suitfiled Settled in the Last 12 Months 4 []
max_dpd_tradeline_last_12months integer false Maximum DPD Tradeline in the Last
12 Months 6 [] max_overdue_tradeline integer false Maximum Overdue Tradeline 6
[] total_overdue_amount_in_last_12m number float false Total Overdue Amount in
the Last 12 Months 10000 [] amount_of_loan_settled_in_last_12m number float
false Loan Amount Settled in the Last 12 Months 25000 [] nature_of_loan_settled1
string false The nature of past loan settlement if any (Loan 1) - Settled/
Closed/ Written-off settled [] nature_of_loan_settled2 string false The nature
of past loan settlement if any (Loan 2) - Settled/ Closed/ Written-off closed []
total_emi_bounces integer false Total EMI Bounces 3 [] bounces_in_last_6m
integer false EMI Bounces in the Last 6 Months 3 [] bounces_in_last_12m integer
false EMI Bounces in the Last 12 Months 3 [] bureau_validity_date string date
false Validity of bureau report 1996-01-01 [] dpd_on_partner string date false
DPD on partner 90 [] max_dpd_tradeline_last_6months string date false Maximum
DPD tradeline in last 6 months 90 [] abb_emi_ratio number float false Average
Bank balance to EMI 2 [] dscr number float false Debt Service Coverage Ratio 3
[] foir number float true Fixed Obligations to Income Ratio 4 [] ltr number
float false Loan Transfer Ratio 5 [] insr number float false INSR 6 []
eligibility_as_per_insr number float false Eligibility as per INSR 10000 []
eligibility_as_per_foir number float false Eligibility as per FOIR 20000 []
eligibility_as_per_ltv number float false Eligibility as per LTV 30000 []
eligibility_loan_amount number float false Eligibility Loan amount 40000 [] fcf
integer false Free Cash Flows 24000 [] emi_obligations integer false Existing
EMI obligations 20000 [] viability_ratio number float false Net Assets/ Debt 2
[] idir_ratio number float false Net Assets/ Debt 2 [] references array false
Refer table References for attributes [{"name":"Neeraj Chopra","address":"221B,
Baker Street, Chennai","pincode":"600001","phone":"9876543210"},{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"}] limit_info object Refer table
LimitInfo for attributes
{"limit_id":10000.0,"total_approved_limit":10000.0,"limit_validity":"1996-01-01"}
VIDEOKYCDETAIL
Field Type Format Required Description Example Master Codes profile_id string
false Required if video KYC is done. Profile ID of the case as per the video KYC
vendor AB12345 [] account_id string false Required if video KYC is done. Account
ID of the case as per the video KYC vendor AB12345 [] key string false Required
if video KYC is done. Key as per the video KYC vendor abc@123 [] auditor string
false Name of the Video KYC Auditor Neeraj Chopra [] officer string false Name
of the Video KYC Officer Neeraj Chopra []
BANKSTATEMENT
View More
Field Type Format Required Description Example Master Codes
bank_statement_savings_account_12_months_link array false Savings bank account
statement for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_savings_account_12_months_link_password string false Savings bank
account statement for last 12 months Document Password 12345678 []
bank_statement_current_account_12_months_link array false Current account bank
details for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_current_account_12_months_link_password string false Current
account bank details for last 12 months Document Password 12345678 []
bank_signature_verification_form string false Bank signature verification
document 12345678 [] no_of_inward_chq_returns_savings_account integer false
Number of inward cheque returns in savings account 3 []
no_of_outward_chq_returns_savings_account integer false Number of outward cheque
returns in savings account 4 [] no_of_inward_chq_returns_current_account integer
false Number of inward cheque returns in current account 5 []
no_of_outward_chq_returns_current_account integer false Number of outward cheque
returns in current account 6 [] bank_account_type_for_assessment string false
Savings / Current / Overdraft / CC savings [] perfios_link array false Perfios
report in form of document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
perfios_link_password string false Perfios report in form of document - password
12345678 [] perfios_json_link array false Perfios Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
perfios_json_link_password string false Perfios Json placed in a link - password
12345678 [] perfios_json array false Perfios Json response ["NA", "NA"]
finbit_link array false Finbit report in form of document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
finbit_link_password string false Finbit report in form of document - Password
12345678 [] finbit_json_link array false Finbit Json placed in a link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
finbit_json_link_password string false FINBIT Json placed in a link - Password
12345678 [] finbit_json array false FINBIT Json response ["NA", "NA"] abb number
float false Average Bank Balance maintaiend on the EMI dates (Calculated by the
Originator for the Last 12 Months) 25000 [] abd number float false Average
Monthly Bank Deposits for the Last 12 Months 10000 [] credit_summation string
false Sum of all the credits in the bank statement 50000 []
REFERENCES
Field Type Format Required Description Example Master Codes name string false
Name of reference Neeraj Chopra [] address string false Address details of
reference 221B, Baker Street, Chennai [] pincode string false Pincode of
reference address 600001 [] phone string false Phone number of reference
9876543210 []
LIMITINFO
Field Type Format Required Description Example Master Codes limit_id number
float true Limit ID for the borrower 10000 [] total_approved_limit number float
true Total approved limit for the borrower 10000 [] limit_validity string date
true Expiry date for the Limit 1996-01-01 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
borrower_id
KAMAL_1
(Required) Client Customer ID as provided during Borrower creation
BODYraw
View More
{
"customer_type": "individual",
"customer_category": "salaried",
// "client_customer_id": "CA_1234",
"title": "Mr",
"first_name": "Neeraj",
"middle_name": "Kumar",
"last_name": "Chopra",
"gender": "o",
"date_of_birth": "1995-12-05",
"age": 26,
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/ca_pvtlt/api/v2/borrowers/AB001' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"customer_type": "individual",
"customer_category": "salaried",
"client_customer_id": "CA_1234",
"product ID": "CA_1234",
"title": "Mr",
"first_name": "Neeraj",
"middle_name": "Kumar",
Example Response
200 OK
Body
Header(1)
{
"success": true
}
POST
Create Loan
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans
CREATE LOAN
This API endpoint can be used to create a loan.
interest_rate: Rate of interest percent per annum
All link fields should have a valid accessible URL or "NA".
States should be in INDIAN_STATES array (refer at the end of the table).
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes client_customer_id
string true Customer id as per partners CRM/LOS CA_1234 [] product_id string
true Product ID created in CA CONSUMER_001 [] client_loan_id string true Loan ID
as per Partner's LMS LOAN00001 [] application_id string true Application ID as
per Partner's CRM/LOS LOAN00001 [] loan_cycle integer false Denotes the Cycle
number of the loan given to the borrower 1 [] partner_branch_code string false
Branch Code as per Partner's LOS ABC123 [] partner_branch_name string false
Branch Name as per Partner's LOS ABC123 [] product_type string false Product
Type Consumer [] partner_product_code string false Product code as per partners
LOS/LMS CONSUMER_001 [] partner_scheme_code string false [] category string true
secured / unsecured unsecured ["secured", "unsecured"] sub_category string true
bt / top_up / fresh top_up ["bt", "top_up", "fresh"] purpose string false Free
flowing text Personal Loan [] disbursement_type string true tranche / single
single ["single", "tranche"] number_of_tranches integer false Total number of
Tranches 2 [] end_borrower_amount number float false End borrower amount in case
of multiple disbursals 40000 [] existing_lender_amount number float false
Existing Lender Amount in case of multiple disbursals 10000 [] principal_amount
number float true Total loan amount in Rs (Overall amount to the borrower)
100000 [] interest_rate number float true Reducing balance interest rate of the
customer in %. This is the interest rate to be mentioned in the sanction letter
as well 20.2 [] interest_type string false Interest Type of the Loan floating []
tenure integer true Tenure of the loan 12 [] tenure_frequency string true
Whether the tenure is monthly/yearly/weekly fortnightly ["weekly", "monthly",
"daily", "fortnightly"] repayment_frequency string true Daily/Weekly/Once in 2
weeks/Monthly/Quarterly/Bullet daily ["weekly", "monthly", "daily", "bullet",
"fortnightly"] number_of_repayments integer true Number of repayments as per the
repayment schedule 12 [] first_repayment_date string date true First repayment
date as per the repayment schedule (YYYY-MM-DD) 2021-08-30 [] repayment_mode
string true Cash / NACH nach ["cash", "nach"] advance_emi number float false
Advance EMI Amount (If collected any) 1000 [] umrn string false To update if
UMRN generated at this stage, else in PDD stage umrn_12345 []
interest_start_date string date false Pre Emi interest due date 1995-10-10 []
differential_interest number float false Broken Period Interest Amount (in
Rupees) 100 [] processing_fee number float true Processing Fee (Inclusive of
GST) 100 [] stamp_duty number float false Stamp duty amount 100 []
insurance_charges number float false Insurance premium inclusive of GST 100 []
documentation_charges number float false Total documentation charges inclusive
of GST 100 [] other_charges number float false Any Other Charges Inclusive of
GST 100 [] loan_plr_type string false [] loan_plr_rate number float false Prime
Lending Rate of the loan 20.2 [] spread_id string false [] loan_emi number float
false EMI of the loan 1000 [] rcu_status string false Document Verification
Status (Y/N) t [] surrogate string false Surrogate [] sub_class string false Sub
Class [] weaker_section string false Whether the borrower belongs to the weaker
section as defined under RBI norms small marginal farmers []
disbursement_accounts array false Refer table DisbursementAccounts for
attributes
[{"account_type":"dealer","bank_name":"HDFC","bank_account_type":"savings","account_name":"Neeraj
Chopra","date_of_bank_account_opening":"1995-01-01","bank_branch_name":"Rajaji
Salai","ifsc_code":"HDFC0000123","entity_type":"dealer","account_no":"1234567890","amount":10000.0},{"account_type":"dealer","bank_name":"HDFC","bank_account_type":"savings","account_name":"Neeraj
Chopra","date_of_bank_account_opening":"1995-01-01","bank_branch_name":"Rajaji
Salai","ifsc_code":"HDFC0000123","entity_type":"dealer","account_no":"1234567890","amount":10000.0}]
references array false Refer table References for attributes [{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"},{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"}] insurance_details array false
Refer table InsuranceDetails for attributes
[{"insurance_type":"credit","insurer_name":"Tata
AIG","nominee_details":"Neeraj","nominee_date_of_birth":"1990-01-01","relationship":"friend","premium":100000.0,"insurance_amount":300000.0,"policy_number":0},{"insurance_type":"credit","insurer_name":"Tata
AIG","nominee_details":"Neeraj","nominee_date_of_birth":"1990-01-01","relationship":"friend","premium":100000.0,"insurance_amount":300000.0,"policy_number":0}]
psl_flag string false Does this loan belong to Priority Sector Lending? t []
psl_description string false Description on Priority Sector Lending [] psl_code
string false Priority Sector Lending code [] psl_proof_link array false Any
documents as proof for PSL
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
psl_proof_link_password string false Document Password 12345678 [] tranches
array false Refer table Tranches for attributes
[{"tranche_number":1,"principal_amount":10000,"differential_interest":100,"processing_fee":50,"stamp_duty":100,"insurance_charges":100,"documentation_charges":100,"other_charges":100,"closing_loan_principal":5000},{"tranche_number":1,"principal_amount":10000,"differential_interest":100,"processing_fee":50,"stamp_duty":100,"insurance_charges":100,"documentation_charges":100,"other_charges":100,"closing_loan_principal":5000}]
linked_loan_infos array false Refer table LinkedLoanInfos for attributes
[{"linked_loan_id":"CA_123","foreclosure":"t","principal":1000.0,"interest":100.0,"other_charges":50.0,"overdue_charges":100.0,"penalty_charges":100.0,"fee_charges":100.0,"bounce_charges":100.0,"amount":100.0},{"linked_loan_id":"CA_123","foreclosure":"t","principal":1000.0,"interest":100.0,"other_charges":50.0,"overdue_charges":100.0,"penalty_charges":100.0,"fee_charges":100.0,"bounce_charges":100.0,"amount":100.0}]
limit_info object Refer table LimitInfo for attributes
{"total_approved_limit":10000.0,"opening_limit_balance":10000.0,"closing_limit_balance":10000.0,"limit_validity":"1996-01-01","revised_total_limit":10000.0,"revised_opening_limit_balance":10000.0,"revised_closing_limit_balance":10000.0,"revised_limit_validity":"1996-01-01"}
sourcing_detail object Refer table SourcingDetail for attributes
{"source_code":"PNB","referrer_code":"referrer_code_28","referrer_group":"referrer_group_12","referrer_name":"Albus","channel_code":"DSA
sourcing","dst_code":"dst_code_62","dsa":"John Pvt
Ltd.","dse":"John","relationship_manager":"Harry"} deviation_details array false
Refer table DeviationDetails for attributes [{"summary":"This deviation refers
to the nature of the segment itself where the corporate on onboarding high debt
can continue to keep capex funding at optimum levels, thus TD/NCA is typically
high in these funding cases","desc":"High TD/NCA","mitigant":"Even though
interest liabilities are higher on account of all current facilities, the
company has shown substantial asset growth and cash flow has remained robust
over the past 3 FY","level":"high"},{"summary":"This deviation refers to the
nature of the segment itself where the corporate on onboarding high debt can
continue to keep capex funding at optimum levels, thus TD/NCA is typically high
in these funding cases","desc":"High TD/NCA","mitigant":"Even though interest
liabilities are higher on account of all current facilities, the company has
shown substantial asset growth and cash flow has remained robust over the past 3
FY","level":"high"}] sanction_letter_link array false Sanction letter issued to
the customer in joint/lenders letter head
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
sanction_letter_link_password string false Sanction letter issued to the
customer in joint/lenders letter head - Password 12345678 []
self_declaration_form_link array false Self declaration form link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
self_declaration_form_link_password string false Self declaration form link
password 12345678 [] fatca_declaration_link array false FATCA declaration
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
fatca_declaration_link_password string false FATCA declaration link password
12345678 [] entire_set_of_loan_agreements_link array false Entire loan agreement
kit ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
entire_set_of_loan_agreements_link_password string false Entire loan agreement
kit password 12345678 [] dpn_link array false DPN Image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
dpn_link_password string false DPN Image password 12345678 [] drf_link array
false DRF Image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
drf_link_password string false DRF Image password 12345678 []
nach_enach_mandate_link array false Nach Enach Mandate Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
nach_enach_mandate_link_password string false Nach Enach Mandate Link Password
12345678 [] credit_discussion_mail_link array false Credit Discussion Mail Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
credit_discussion_mail_link_password string false Credit Discussion Mail Link
Password 12345678 [] field_verification_report_link array false Field
Verification Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
field_verification_report_link_password string false Field Verification Report
Link Password 12345678 [] tele_verification_report_link array false Tele
Verification Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tele_verification_report_link_password string false Tele Verification Report
Link Password 12345678 [] vehicle_inspection_report_link array false Vehicle
Inspection Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
vehicle_inspection_report_link_password string false Vehicle Inspection Report
Link Password 12345678 [] insurance_application_form_link array false Insurance
Application Form Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
insurance_application_form_link_password string false Insurance Application Form
Link Password 12345678 []
DISBURSEMENTACCOUNTS
View More
Field Type Format Required Description Example Master Codes account_type string
true borrower / existing_lender / dealer / sub_dealer / seller / financier
dealer [] bank_name string true Name of the bank where disbursement needs to be
done HDFC [] bank_account_type string true Account type -
Savings/Current/Overdraft/CC savings [] account_name string true Bank account
name where disbursement needs to be done Neeraj Chopra []
date_of_bank_account_opening string date false Date on which the bank account is
opened 1995-01-01 [] bank_branch_name string false Bank branch name where
disbursement needs to be done Rajaji Salai [] ifsc_code string true Bank IFSC
where disbursement needs to be done HDFC0000123 [] entity_type string false
dealer / sub_dealer / originator / existing_lender / end_customer dealer []
account_no string true Account number of the bank where disbursement needs to be
done 1234567890 [] amount number float true Amount to be transferred to
particular Vendor/Borrower 10000 []
INSURANCEDETAILS
View More
Field Type Format Required Description Example Master Codes insurance_type
string false Enter 'credit' credit [] insurer_name string false Loan Insurer
Name Tata AIG [] nominee_details string false Applicable if Credit Shield
insurance is taken. Name of the nominee to be provided Neeraj []
nominee_date_of_birth string date false Applicable if Credit Shield insurance is
taken. DOB of the nominee to be provided 1990-01-01 [] relationship string false
Applicable if Credit Shield insurance is taken. Relationship of nominee to be
provided friend [] premium number float false Applicable if Credit Shield
insurance is taken. Premium amount 100000 [] insurance_amount number float false
Applicable if Credit Shield insurance is taken. Total insurance amount 300000 []
policy_number integer false Applicable if Credit Shield insurance is taken.
Policy number ABC12345 []
TRANCHES
View More
Field Type Format Required Description Example Master Codes tranche_number
integer false Tranche Number 1 [] principal_amount integer false Principal
amount to be disbursed in the tranche 10000 [] differential_interest integer
false Broken period interest amount 100 [] processing_fee integer false
Processing fee amount (Inckusive of GST) 50 [] stamp_duty integer false Stamp
duty amount 100 [] insurance_charges integer false Insurance premium inclusive
of GST 100 [] documentation_charges integer false Total documentation charges
inclusive of GST 100 [] other_charges integer false Any other charges inclusive
of GST 100 [] closing_loan_principal integer false Balance principal amount
after this tranche 5000 []
LINKEDLOANINFOS
View More
Field Type Format Required Description Example Master Codes linked_loan_id
string false client Loan id of the loan that have to be linked to the current
loan CA_123 [] foreclosure string false whether the loan has to be foreclosed or
not. true/false t [] principal number float false Foreclosure principal for
corresponding Linked loan being foreclosed 1000 [] interest number float false
Foreclosure interest for corresponding Linked loan being foreclosed 100 []
other_charges number float false Foreclosure charges for corresponding Linked
loan being foreclosed 50 [] overdue_charges number float false Foreclosure
charges for corresponding Linked loan being foreclosed 100 [] penalty_charges
number float false Foreclosure charges for corresponding Linked loan being
foreclosed 100 [] fee_charges number float false Foreclosure charges for
corresponding Linked loan being foreclosed 100 [] bounce_charges number float
false Foreclosure charges for corresponding Linked loan being foreclosed 100 []
amount number float false Foreclosure charges for corresponding Linked loan
being foreclosed 100 []
LIMITINFO
View More
Field Type Format Required Description Example Master Codes total_approved_limit
number float true Total approved limit for the borrower 10000 []
opening_limit_balance number float true Opening limit balance 10000 []
closing_limit_balance number float true Closing balance of limit after this loan
10000 [] limit_validity string date true Expiry date for the Limit 1996-01-01 []
revised_total_limit number float false Revised Limit for the borrower 10000 []
revised_opening_limit_balance number float false Opening limit balance basis the
revised limit 10000 [] revised_closing_limit_balance number float false Closing
limit balance basis the revised limit 10000 [] revised_limit_validity string
date false Revised expiry 1996-01-01 []
SOURCINGDETAIL
View More
Field Type Format Required Description Example Master Codes source_code string
true Originating system code PNB [] referrer_code string false Referrer code in
the financial institution's own CRM system [] referrer_group string false
Referrer banking vertical in the financial institution's own CRM system []
referrer_name string false Name of the lead referrer Albus [] channel_code
string false Which channel of sourcing it was? DSA sourcing [] dst_code string
false [] dsa string true Name of the Direct Selling Agent John Pvt Ltd. [] dse
string false Name of the Direct Selling Executive John [] relationship_manager
string true Name of the Relationship Manager Harry []
DEVIATIONDETAILS
View More
Field Type Format Required Description Example Master Codes summary string false
Summary details of the deviation being taken This deviation refers to the nature
of the segment itself where the corporate on onboarding high debt can continue
to keep capex funding at optimum levels, thus TD/NCA is typically high in these
funding cases [] desc string false Description of the deviation requested High
TD/NCA [] mitigant string false Mitigant description Even though interest
liabilities are higher on account of all current facilities, the company has
shown substantial asset growth and cash flow has remained robust over the past 3
FY [] level string false Severity of the deviation being requested high []
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 422 Unprocessable Entity
* Client Loan Already Taken
* Product Not Found
* Document not found/accessible
500 Internal Server Error Error occurred in the backend
INDIAN STATES
* jammu_kashmir
* himachal_pradesh
* punjab
* chandigarh
* uttaranchal
* haryana
* delhi
* rajasthan
* uttar_pradesh
* bihar
* sikkim
* arunachal_pradesh
* nagaland
* manipur
* mizoram
* tripura
* meghalaya
* assam
* west_bengal
* jharkhand
* orissa
* chhattisgarh
* madhya_pradesh
* gujarat
* daman_diu
* dadra_nagar_haveli
* maharashtra
* andhra_pradesh
* karnataka
* goa
* lakshadweep
* kerala
* tamil_nadu
* pondicherry
* andaman_nicobar_islands
* telangana
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
BODYraw
View More
{
"customer_type": "individual",
"customer_category": "self_employed_professional",
"client_customer_id": "CA_1236",
"title": "Mr",
"first_name": "Neeraj",
"middle_name": "Kumar",
"last_name": "Chopra",
"category": "secured",
"sub_category": "fresh",
"purpose": "Personal Loan",
201 Created
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"customer_type": "individual",
"customer_category": "self_employed_professional",
"client_customer_id": "CA_1234",
"title": "Mr",
"first_name": "Neeraj",
"middle_name": "Kumar",
"last_name": "Chopra",
Example Response
201 Created
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "new"
}
GET
Get Loan Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id
GET LOAN DETAILS
This API endpoint can be used to get the loan details. The possible loan status
values are
LOAN STATUS
State Description new When the loan is created approved When the loan is
approved by the investor rejected When the loan is rejected by the investor
agreement_signed When end borrower agreement/EKYC is signed/collected
disbursement_ready When investor is ready to disburse the funds dropped When the
loan gets rejected by the investor at agreement signed state disbursed When the
loan moves to the disbursed state by the investor from agreement signed state
matured After closure of all installments, the loan moves to the matured state
RESPONSE CODES
Code Message Reason 200 OK Success 401 Unauthorized Invalid API Key 404 Not
found Loan not found 500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
PATH VARIABLES
client_name
{{client_name}}
(Required) Name of the client
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
View More
{
"client_loan_id": "AB001",
"principal_amount": 20000,
"disbursement_type": "single",
"interest_rate": 20.2,
"tenure": 2,
"tenure_frequency": "daily",
"cibil_score": null,
"purpose": "Personal Loan",
"repayment_frequency": "daily",
"number_of_repayments": 2,
PUT
Update Loan
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id
UPDATE LOAN API
This endpoint can be used to update the loan status to agreement signed.
Expected Loan Status: "approved"
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes principal_amount
number float false Total Loan Amount to the Borrower (in Rupees) 1000000 []
loan_amount number float false Total Loan Amount 1000000 [] interest_rate number
float false Reducing balance interest rate of the customer in %. This is the
interest rate to be mentioned in the sanction letter as well 20.2 [] tenure
integer false Tenure of the loan 12 [] tenure_frequency string false Daily /
Weekly / Monthly monthly ["weekly", "monthly", "daily", "fortnightly"]
repayment_frequency string false Daily / Weekly / Monthly / Bullet bullet
["weekly", "monthly", "daily", "bullet", "fortnightly"] number_of_repayments
integer false Number of repayments as per the repayment schedule 12 []
disbursement_accounts array false Refer table DisbursementAccounts for
attributes
[{"id":"1","account_type":"borrower","bank_name":"HDFC","bank_account_type":"savings","account_name":"Arya","bank_branch_name":"Nandanam","ifsc_code":"HDFC0000123","entity_type":"end_customer","account_no":"54321678912","amount":100000.0},{"id":"1","account_type":"borrower","bank_name":"HDFC","bank_account_type":"savings","account_name":"Arya","bank_branch_name":"Nandanam","ifsc_code":"HDFC0000123","entity_type":"end_customer","account_no":"54321678912","amount":100000.0}]
DISBURSEMENTACCOUNTS
View More
Field Type Format Required Description Example Master Codes id string true ID as
provided in Get Loan Details API 1 [] account_type string false
Borrower/Existing Lender borrower [] bank_name string false Name of the bank
where disbursement needs to be done HDFC [] bank_account_type string false
Account type - Savings/Current/Overdraft/CC savings ["savings", "current",
"overdraft", "cc"] account_name string false Bank account name where
disbursement needs to be done Arya [] bank_branch_name string false Bank branch
name where disbursement needs to be done Nandanam [] ifsc_code string false Bank
IFSC where disbursement needs to be done HDFC0000123 [] entity_type string false
Dealer / Sub-Dealer / Originator / Existing Lender / End Customer end_customer
["dealer", "sub_dealer", "originator", "existing_lender", "end_customer"]
account_no string false Account number of the bank where disbursement needs to
be done 54321678912 [] amount number float false Amount to be transferred to
particular Vendor/Borrower 100000 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"principal_amount": 1000000,
"loan_amount": 1000000,
"interest_rate": 20.2,
"tenure": 12,
"tenure_frequency": "monthly",
"repayment_frequency": "bullet",
"number_of_repayments": 12,
"disbursement_accounts": [
{
"id": "1",
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"principal_amount": 1000000,
"loan_amount": 1000000,
"interest_rate": 20.2,
"tenure": 12,
"tenure_frequency": "monthly",
"repayment_frequency": "bullet",
"number_of_repayments": 12,
Example Response
200 OK
Body
Header(1)
{
"success": true
}
PUT
Agreement Signed
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/agreement_signed
AGREEMENT SIGNED API
This endpoint can be used to update the loan status to agreement signed.
Expected Loan Status: "approved"
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes
agreement_consent_timestamp string true Agreement Signed TimeStamp 11-02-2022
sanction_letter_link array false Sanction letter issued to the customer in
joint/lenders letter head
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
sanction_letter_link array false Sanction letter issued to the customer in
joint/lenders letter head
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
sanction_letter_link_password string false Sanction letter issued to the
customer in joint/lenders letter head - Password 12345678 []
self_declaration_form_link array false Self declaration form link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
self_declaration_form_link_password string false Self declaration form link
password 12345678 [] fatca_declaration_link array false FATCA declaration
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
fatca_declaration_link_password string false FATCA declaration link password
12345678 [] entire_set_of_loan_agreements_link array false Entire loan agreement
kit ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
entire_set_of_loan_agreements_link_password string false Entire loan agreement
kit password 12345678 [] dpn_link array false DPN Image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
dpn_link_password string false DPN Image password 12345678 [] drf_link array
false DRF Image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
drf_link_password string false DRF Image password 12345678 []
nach_enach_mandate_link array false Nach Enach Mandate Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
nach_enach_mandate_link_password string false Nach Enach Mandate Link Password
12345678 [] credit_discussion_mail_link array false Credit Discussion Mail Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
credit_discussion_mail_link_password string false Credit Discussion Mail Link
Password 12345678 [] field_verification_report_link array false Field
Verification Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
field_verification_report_link_password string false Field Verification Report
Link Password 12345678 [] tele_verification_report_link array false Tele
Verification Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tele_verification_report_link_password string false Tele Verification Report
Link Password 12345678 [] vehicle_inspection_report_link array false Vehicle
Inspection Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
vehicle_inspection_report_link_password string false Vehicle Inspection Report
Link Password 12345678 [] insurance_application_form_link array false Insurance
Application Form Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
insurance_application_form_link_password string false Insurance Application Form
Link Password 12345678 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"agreement_consent_timestamp": "11-01-2022",
"sanction_letter_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"
],
"sanction_letter_link_password": "12345678",
"self_declaration_form_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"
],
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/whizdm/api/v2/loans/AB001/agreement_signed' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"sanction_letter_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"
],
"sanction_letter_link_password": "12345678",
"self_declaration_form_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "agreement_signed"
}
PUT
Disburse Loan
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/disburse
DISBURSE LOAN API
This endpoint can be used to disburse the loan.
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes first_repayment_date
string date false First repayment date as per repayment schedule 2021-02-02 []
disbursement_date string date false Disbursement date to the end customer
2021-01-02 [] instrument_number string false UTR / Cheque Number UTR123456 []
instrument_type string false RTGS / NEFT / UPI / Cheque NEFT []
penny_test_status boolean boolean true Penny Test Status true []
penny_test_report_link array false Penny Test Status Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
penny_test_report_link_password string false Penny Test Status Report Link
Password 12345678 [] disbursement_accounts array false Refer table
DisbursementAccounts for attributes
[{"account_no":"42710779755","disbursement_date":"2021-01-02","disbursed_amount":100000.0,"instrument_number":"UTR123456","instrument_type":"NEFT"},{"account_no":"42710779755","disbursement_date":"2021-01-02","disbursed_amount":100000.0,"instrument_number":"UTR123456","instrument_type":"NEFT"}]
DISBURSEMENTACCOUNTS
Field Type Format Required Description Example Master Codes account_no string
true Account number of the bank where disbursement needs to be done 42710779755
[] disbursement_date string date true Disbursement date to the end customer
2021-01-02 [] disbursed_amount number float true Disbursed Amount 100000 []
instrument_number string true UTR / Cheque Number UTR123456 [] instrument_type
string true RTGS / NEFT / UPI / Cheque NEFT []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"first_repayment_date": "2021-02-02",
"disbursement_date": "2021-01-02",
"instrument_number": "UTR123456",
"instrument_type": "NEFT",
"penny_test_status": true,
"penny_test_report_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"
],
"penny_test_report_link_password": "12345678",
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/disburse' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"first_repayment_date": "2021-02-02",
"disbursement_date": "2021-01-02",
"instrument_number": "UTR123456",
"instrument_type": "NEFT",
"penny_test_status": true,
"penny_test_report_link": [
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "agreement_signed"
}
PUT
Approve Fund Transfer
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/approve_fund_transfer
APPROVE FUND TRANSFER API
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
BODYraw
{}
200 OK
Example Request
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/approve_fund_transfer' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{}'
Example Response
200 OK
Body
Header(1)
{
"success": true
}
PUT
Update Post Disbursement
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/update_post_disbursement
UPDATE POST DISBURSEMENT API
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes customer_type string
false Individual / Corporate individual [] customer_category string false
Salaried, Self-Empolyed salaried ["salaried", "self_employed_professional",
"self_employed", "others"] first_name string false First Name of the Customer
Neeraj [] middle_name string false Middle Name of the Customer Kumar []
last_name string false Last Name of the Customer Chopra [] gender string false M
/ F / O m ["m", "f", "o"] date_of_birth string date false Date of birth in
YYYY-MM-DD 1995-12-05 [] age integer false Age in years 26 [] mobile_number
integer false Mobile Number of the Customer (10 digits) 9876543210 [] email
string false Permanent Email id of the Customer minato@gmail.com []
official_email_id string false Official Email ID of the Customer
minato_namikaze@credavenue.com [] current_address string false Current address
of the applicant. Free flowing text 221B, Baker Street, Chennai [] current_city
string false City in which applicant is currently residing. Free flowing for now
Chennai [] current_district string false District in which applicant is
currently residing. Free flowing for now Chennai [] current_state string false
State in which applicant is currently residing. Free flowing for now
chhattisgarh ["jammu_kashmir", "himachal_pradesh", "punjab", "chandigarh",
"uttaranchal", "haryana", "delhi", "rajasthan", "uttar_pradesh", "bihar",
"sikkim", "arunachal_pradesh", "nagaland", "manipur", "mizoram", "tripura",
"meghalaya", "assam", "west_bengal", "jharkhand", "orissa", "chhattisgarh",
"madhya_pradesh", "gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra",
"andhra_pradesh", "karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu",
"pondicherry", "andaman_nicobar_islands", "telangana"] current_pincode integer
false Pincode of the current address 600089 [] residence_type_current_address
string false rented / owned / leased leased ["rented", "owned", "leased"]
years_of_stay_in_current_address integer false How many years stayed in the
current address 5 [] permanent_address string false Permanent address of the
customer. Free flowing for now 221B, Baker Street, Chennai [] permanent_city
string false Permanent city of the customer. Free flowing for now Chennai []
permanent_district string false Permanent district of the customer. Free flowing
for now Chennai [] permanent_state string false Permanent state of the customer.
Free flowing for now andaman_nicobar_islands ["jammu_kashmir",
"himachal_pradesh", "punjab", "chandigarh", "uttaranchal", "haryana", "delhi",
"rajasthan", "uttar_pradesh", "bihar", "sikkim", "arunachal_pradesh",
"nagaland", "manipur", "mizoram", "tripura", "meghalaya", "assam",
"west_bengal", "jharkhand", "orissa", "chhattisgarh", "madhya_pradesh",
"gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra", "andhra_pradesh",
"karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu", "pondicherry",
"andaman_nicobar_islands", "telangana"] permanent_pincode integer false
Permanent pincode of the customer. Free flowing for now 600089 []
residence_type_permanent_address string false rented / owned / leased owned
["rented", "owned", "leased"] years_of_stay_in_permanent_address integer false
How many years stayed in the permanent address 5 [] marital_status string false
married / unmarried unmarried ["married", "unmarried"] religion string false
Religion of customer. Free flow text Hindu [] nationality string false
Nationality of customer. Free flow text indian [] father_name string false
Father name of customer. Free flow text Dan Kato [] mother_name string false
Mother name of customer; Free flow text Tsunade Senju [] spouse_name string
false Spouse name of customer; Free flow text Kushina Uzumaki []
education_qualification string false Educational Qualifications MBA []
net_monthly_income number float false Monthly Income of the Customer (in Rupees)
10000 [] annual_income number float false Annual income of the customer in
number (don’t convert into thousand/lacs etc) 120000 [] no_of_dependants integer
false Number of dependants 3 [] occupation string false salaried / business /
retired / self_employed and others salaried [] pan_number string false PAN
number of customer BMMPH9018G [] pan_number_link array false PAN image of the
document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
form_60_link array false Form 60 If applicable
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aadhar_number string false Aadhar number of customer 794065231234 [] aadhar_link
array false Aadhar image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
voter_id_number string false Voter ID Number of customer RTG2291234 []
voting_id_link array false Voter ID image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
driving_license_number string false Driving license number of customer TN0112345
[] driving_license_link array false Driving License image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
passport_number string false Passport number of customer L4018345 []
passport_link array false Passport image of the document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_image_link array false Video KYC of the Applicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_kyc_detail object Refer table VideoKycDetail for attributes
{"profile_id":"AB12345","account_id":"AB12345","key":"abc@123"} other_kyc_number
string false KYC Number of the Customer ABC1234 [] other_kyc_link array false
KYC Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
rent_agreement_link array false KYC number of customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
utility_bills_link array false Utility bills link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
photo_link array false Photo Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
employment_type string false salaried / self_employed self_employed []
employment_details_name string false Employer name. Free flowing text Credavenue
[] employment_details_address string false Office address. Free flowing text
221B, Baker Street, Chennai [] employment_details_years_of_experience number
float false Applicant Number of years in the current organization 5 []
employment_details_designation string false Designation in current role, free
flowing text Manager [] employement_vintage_current_organisation integer false
No of Years in the same Organisation 3 [] payslip_link array false Last three
month pay slip
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tds_certificate_link array false Last Three Year TDS Certificate Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
name_of_bureau string false Cibil / Experian / Himark cibil [] bureau_vintage
integer false Vintage in the bureau. Number of years from the first trade line 3
[] bureau_score integer false Bureau Score 650 [] bureau_report_link array false
Document of the bureau
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
commercial_bureau_score integer false CRIF score 330 []
commercial_bureau_score_link array false Commercial Bureau Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
partner_score_on_the_customer number float false Score Captured by the Partner
800 [] total_existing_obligations integer false Total Existing Obligations basis
the Bureau Report 25000 [] credit_card_limit integer false Total Credit Card
Limit basis the Bureau Report 30000 [] number_of_credit_cards integer false
Total Number of Credit Cards per Bureau Report 3 [] number_of_unsecured_loans
integer false Total Number of Unsecured Loans per Bureau Report 2 []
value_of_total_unsecured_loans number float false Total value of unsecured loans
20000 [] number_of_loans integer false Total Number of Loans per Bureau Report 2
[] value_of_total_loans number float false Total value of loans 20000 []
number_of_enquiries_3months integer false Number of Enquiries in the Last 3
Months per Bureau Report 3 [] number_of_enquiries_6months integer false Number
of Enquiries in the Last 6 Months per Bureau Report 3 []
number_of_enquiries_12months integer false Number of Enquiries in the Last 12
Months per Bureau Report 4 [] number_of_writeoff_suitfiled_settled_12months
integer false Number of Writeoff Suitfiled Settled in the Last 12 Months 4 []
max_dpd_tradeline_12months integer false Maximum DPD Tradeline in the Last 12
Months 6 [] max_overdue_tradeline integer false Maximum Overdue Tradeline 6 []
total_overdue_amount_12months number float false Total Overdue Amount in the
Last 12 Months 10000 [] loan_amount_settled_12months number float false Loan
Amount Settled in the Last 12 Months 25000 [] nature_of_loan_settled1 string
true The nature of past loan settlement if any (Loan 1) - Settled/ Closed/
Written-off settled [] nature_of_loan_settled2 string true The nature of past
loan settlement if any (Loan 2) - Settled/ Closed/ Written-off closed []
total_emi_bounces integer false Total EMI Bounces 3 [] emi_bounces_6months
integer false EMI Bounces in the Last 6 Months 3 [] emi_bounces_12months integer
false EMI Bounces in the Last 12 Months 3 [] bank_statement object Refer table
BankStatement for attributes
{"bank_statement_savings_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_current_account_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"no_of_inward_chq_returns_savings_account":3,"no_of_outward_chq_returns_savings_account":4,"no_of_inward_chq_returns_current_account":5,"no_of_outward_chq_returns_current_account":6,"bank_account_type_for_assessment":"savings","perfios_link":"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","finbit_link":"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","abb":25000.0,"abd":10000.0}
financial_data object Refer table FinancialData for attributes
{"annual_business_turnover":1000000.0,"annual_gross_profit":8000000.0,"annual_business_ebitda":5000000.0,"monthly_net_profit":14000.0,"annual_net_profit":30000000.0,"gst_return_year_1_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"gst_return_year_2_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"gst_return_year_3_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_1_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_2_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"it_return_year_3_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_income_assessment_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cam_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cfa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]}
co_applicants array false Refer table CoApplicants for attributes
[{"relationship_with_applicant":"father","first_name":"Minato","middle_name":"Kumar","last_name":"Namikaze","gender":"M","date_of_birth":"1995-12-05","age":26,"mobile_number":9876543210,"email":"minato@gmail.com","current_address":"2,
Mount Road,
Teynampet","current_city":"Chennai","current_district":"Chennai","current_state":"tamil_nadu","current_pincode":600089,"residence_type_current_address":"rented","years_of_stay_in_current_address":5,"permanent_address":"2,
Mount Road,
Teynampet","permanent_city":"Chennai","permanent_district":"Chennai","permanent_state":"tamil_nadu","permanent_pincode":600089,"residence_type_permanent_address":"owned","years_of_stay_in_permanent_address":5,"marital_status":"unmarried","religion":"buddhist","nationality":"indian","father_name":"Dan
Kato","mother_name":"Tsunade Senju","spouse_name":"Kushina
Uzumaki","education":"Hokage","annual_income":120000.0,"income_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"pan_number":"BMMPG9018Y","pan_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"aadhar_number":"794065346725","aadhar_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"voter_id_number":"RTG2291234","voting_id_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"driving_license_number":"TN01123345","driving_license_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"passport_number":"L4018345","passport_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"video_kyc_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"video_kyc_profile_id":"ABC12345","video_kyc_account_id":"ABC12345","video_kyc_key":"abc_123","other_kyc_number":"ABC12456","other_kyc_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"rent_agreement_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"utility_bills_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"photo_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bureau_score":700,"bureau_report_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partner_score":3},{"relationship_with_applicant":"father","first_name":"Minato","middle_name":"Kumar","last_name":"Namikaze","gender":"M","date_of_birth":"1995-12-05","age":26,"mobile_number":9876543210,"email":"minato@gmail.com","current_address":"2,
Mount Road,
Teynampet","current_city":"Chennai","current_district":"Chennai","current_state":"tamil_nadu","current_pincode":600089,"residence_type_current_address":"rented","years_of_stay_in_current_address":5,"permanent_address":"2,
Mount Road,
Teynampet","permanent_city":"Chennai","permanent_district":"Chennai","permanent_state":"tamil_nadu","permanent_pincode":600089,"residence_type_permanent_address":"owned","years_of_stay_in_permanent_address":5,"marital_status":"unmarried","religion":"buddhist","nationality":"indian","father_name":"Dan
Kato","mother_name":"Tsunade Senju","spouse_name":"Kushina
Uzumaki","education":"Hokage","annual_income":120000.0,"income_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bank_statement_12_months_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"pan_number":"BMMPG9018Y","pan_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"aadhar_number":"794065346725","aadhar_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"voter_id_number":"RTG2291234","voting_id_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"driving_license_number":"TN01123345","driving_license_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"passport_number":"L4018345","passport_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"video_kyc_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"video_kyc_profile_id":"ABC12345","video_kyc_account_id":"ABC12345","video_kyc_key":"abc_123","other_kyc_number":"ABC12456","other_kyc_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"rent_agreement_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"utility_bills_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"photo_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bureau_score":700,"bureau_report_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partner_score":3}]
abb_emi_ratio number float false Average Bank balance to EMI 2 [] dscr number
float false Debt Service Coverage Ratio 3 [] foir number float false Fixed
Obligations to Income Ratio 4 [] ltr number float false Loan Transfer Ratio 5 []
eligibility_loan_amount number float false Eligibility Loan amount 40000 []
insurance_details array false Refer table InsuranceDetails for attributes
[{"insurance_type":"credit","insurer_name":"Tata
AIG","nominee_details":"Neeraj","relationship":"friend","premium":100000.0,"insurance_amount":300000.0,"policy_number":"ABC12345"},{"insurance_type":"credit","insurer_name":"Tata
AIG","nominee_details":"Neeraj","relationship":"friend","premium":100000.0,"insurance_amount":300000.0,"policy_number":"ABC12345"}]
references array false Refer table References for attributes [{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"},{"name":"Neeraj
Chopra","address":"221B, Baker Street,
Chennai","pincode":"600001","phone":"9876543210"}] psl_flag string false Does
this loan belong to Priority Sector Lending? t [] psl_description string false
Description on Priority Sector Lending [] psl_code string false Priority Sector
Lending code [] psl_proof_link array false Any documents as proof for PSL
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
loan_agreement_link array false Loan Agreement Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
sanction_letter_link array false Sanction letter Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
laf_link array false LAF Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
self_declaration_letter_link array false Self declaration form link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
authorisation_letter_link array false Authorisation letter link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
enach_pdc_link array false eNACH PDC Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
guarantor_agreements_link array false Guarantor Agreements Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
VIDEOKYCDETAIL
Field Type Format Required Description Example Master Codes profile_id string
false Required if video KYC is done. Profile ID of the case as per the video KYC
vendor AB12345 [] account_id string false Required if video KYC is done. Account
ID of the case as per the video KYC vendor AB12345 [] key string false Required
if video KYC is done. Key as per the video KYC vendor abc@123 []
BANKSTATEMENT
View More
Field Type Format Required Description Example Master Codes
bank_statement_savings_account_12_months_link array false Savings bank account
statement for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_current_account_12_months_link array false Current account bank
details for last 12 months
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
no_of_inward_chq_returns_savings_account integer false Number of inward cheque
returns in savings account 3 [] no_of_outward_chq_returns_savings_account
integer false Number of outward cheque returns in savings account 4 []
no_of_inward_chq_returns_current_account integer false Number of inward cheque
returns in current account 5 [] no_of_outward_chq_returns_current_account
integer false Number of outward cheque returns in current account 6 []
bank_account_type_for_assessment string false Savings / Current / Overdraft / CC
savings [] perfios_link string false Perfios report in form of document
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg []
finbit_link string false Finbit Link
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg [] abb
number float false Average Bank Balance maintaiend on the EMI dates (Calculated
by the Originator for the Last 12 Months) 25000 [] abd number float false
Average Monthly Bank Deposits for the Last 12 Months 10000 []
FINANCIALDATA
View More
Field Type Format Required Description Example Master Codes
annual_business_turnover number float false Annual Business Turnover (in Rupees)
1000000 [] annual_gross_profit number float false Annual Gross Profit (in
Rupees) 8000000 [] annual_business_ebitda number float false Annual Business
EBITDA (in Rupees) 5000000 [] monthly_net_profit number float false Monthly Net
Profit (in Rupees) 14000 [] annual_net_profit number float false Net Profit
After Tax (in Rupees) 30000000 [] gst_return_year_1_link array false GST return
image for last year
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
gst_return_year_2_link array false GST return image for last year -1
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
gst_return_year_3_link array false GST return image for last year -2
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_1_link array false IT return image for last year
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_2_link array false IT return image for last year -1
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
it_return_year_3_link array false IT return image for last year - 2
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_income_assessment_proof_link array false Image of other bills
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
cam_link array false CAM Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
cfa_link array false CFA Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
COAPPLICANTS
View More
Field Type Format Required Description Example Master Codes
relationship_with_applicant string false
Father/Mother/Brother/Son/Daughter/Friend/Other relative father [] first_name
string false First Name of the CoApplicant Minato [] middle_name string false
Middle Name of the CoApplicant Kumar [] last_name string false Last Name of the
CoApplicant Namikaze [] gender string false M / F / O o ["m", "f", "o"]
date_of_birth string date false Date of Birth (YYYY-MM-DD) 1995-12-05 [] age
integer false Age in years 26 [] mobile_number integer false Mobile Number of
the CoApplicant (10 digits) 9876543210 [] email string false Personal Email ID
of the CoApplicant minato@gmail.com [] current_address string false Free flowing
text 2, Mount Road, Teynampet [] current_city string false City in which
CoApplicant is currently residing Chennai [] current_district string false
District in which CoApplicant is currently residing Chennai [] current_state
string false State in which CoApplicant is currently residing meghalaya
["jammu_kashmir", "himachal_pradesh", "punjab", "chandigarh", "uttaranchal",
"haryana", "delhi", "rajasthan", "uttar_pradesh", "bihar", "sikkim",
"arunachal_pradesh", "nagaland", "manipur", "mizoram", "tripura", "meghalaya",
"assam", "west_bengal", "jharkhand", "orissa", "chhattisgarh", "madhya_pradesh",
"gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra", "andhra_pradesh",
"karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu", "pondicherry",
"andaman_nicobar_islands", "telangana"] current_pincode integer false Pincode of
the current address 600089 [] residence_type_current_address string false rented
/ owned / leased rented ["rented", "owned", "leased"]
years_of_stay_in_current_address integer false How many years stayed in the
current address 5 [] permanent_address string false Free flowing text 2, Mount
Road, Teynampet [] permanent_city string false City in which CoApplicant is
currently residing Chennai [] permanent_district string false District in which
CoApplicant is currently residing Chennai [] permanent_state string false State
in which CoApplicant is currently residing manipur ["jammu_kashmir",
"himachal_pradesh", "punjab", "chandigarh", "uttaranchal", "haryana", "delhi",
"rajasthan", "uttar_pradesh", "bihar", "sikkim", "arunachal_pradesh",
"nagaland", "manipur", "mizoram", "tripura", "meghalaya", "assam",
"west_bengal", "jharkhand", "orissa", "chhattisgarh", "madhya_pradesh",
"gujarat", "daman_diu", "dadra_nagar_haveli", "maharashtra", "andhra_pradesh",
"karnataka", "goa", "lakshadweep", "kerala", "tamil_nadu", "pondicherry",
"andaman_nicobar_islands", "telangana"] permanent_pincode integer false Pincode
of the current address 600089 [] residence_type_permanent_address string false
rented / owned / leased rented ["rented", "owned", "leased"]
years_of_stay_in_permanent_address integer false How many years stayed in the
permanent address 5 [] marital_status string false Married / Unmarried unmarried
["married", "unmarried"] religion string false Religion of the CoApplicant
buddhist [] nationality string false Nationality of the CoApplicant indian []
father_name string false Father Name of the CoApplicant Dan Kato [] mother_name
string false Mother Name of the CoApplicant Tsunade Senju [] spouse_name string
false Spouse Name of the CoApplicant Kushina Uzumaki [] education string false
Free flowing text Hokage [] annual_income number float false Annual Income of
the CoApplicant (in Rupees) 120000 [] income_proof_link array false CoApplicant
Income Proof Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bank_statement_12_months_link array false CoApplicant Bank Statement Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
pan_number string false PAN Number of the CoApplicant (10 digit Alphanumeric)
BMMPG9018Y [] pan_link array false PAN Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aadhar_number string false Aadhar Number of the CoApplicant (12 digits)
794065346725 [] aadhar_link array false Aadhar Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
voter_id_number string false Voter ID Number of the CoApplicant RTG2291234 []
voting_id_link array false Voter Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
driving_license_number string false Driving License Number of the CoApplicant
TN01123345 [] driving_license_link array false Driving License Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
passport_number string false Passport Number of the CoApplicant L4018345 []
passport_link array false Passport Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_kyc_link array false Video KYC of the CoApplicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_kyc_profile_id string false Required if video KYC is done. Profile ID of
the case as per the video KYC vendor ABC12345 [] video_kyc_account_id string
false Required if video KYC is done. Account ID of the case as per the video KYC
vendor ABC12345 [] video_kyc_key string false Required if video KYC is done. Key
as per the video KYC vendor abc_123 [] other_kyc_number string false KYC Number
of the CoApplicant ABC12456 [] other_kyc_link array false KYC Image of the
CoApplicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
rent_agreement_link array false CoApplicant Rent Agreement Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
utility_bills_link array false Utility Bills Copies (If any)
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
photo_link array false Photo Image of the CoApplicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_score integer false Bureau Score of the CoApplicant 700 []
bureau_report_link array false CoApplicant's Bureau Report Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
partner_score integer false Score Captured by the Partner 3 []
INSURANCEDETAILS
View More
Field Type Format Required Description Example Master Codes insurance_type
string false Enter 'credit' credit [] insurer_name string false Loan Insurer
Name Tata AIG [] nominee_details string false Applicable if Credit Shield
insurance is taken. Name of the nominee to be provided Neeraj [] relationship
string false Applicable if Credit Shield insurance is taken. Relationship of
nominee to be provided friend [] premium number float false Applicable if Credit
Shield insurance is taken. Premium amount 100000 [] insurance_amount number
float false Applicable if Credit Shield insurance is taken. Total insurance
amount 300000 [] policy_number string false Applicable if Credit Shield
insurance is taken. Policy number ABC12345 []
REFERENCES
Field Type Format Required Description Example Master Codes name string false
Name of reference Neeraj Chopra [] address string false Address details of
reference 221B, Baker Street, Chennai [] pincode string false Pincode of
reference address 600001 [] phone string false Phone number of reference
9876543210 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
INDIAN STATES
* jammu_kashmir
* himachal_pradesh
* punjab
* chandigarh
* uttaranchal
* haryana
* delhi
* rajasthan
* uttar_pradesh
* bihar
* sikkim
* arunachal_pradesh
* nagaland
* manipur
* mizoram
* tripura
* meghalaya
* assam
* west_bengal
* jharkhand
* orissa
* chhattisgarh
* madhya_pradesh
* gujarat
* daman_diu
* dadra_nagar_haveli
* maharashtra
* andhra_pradesh
* karnataka
* goa
* lakshadweep
* kerala
* tamil_nadu
* pondicherry
* andaman_nicobar_islands
* telangana
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"customer_type": "individual",
"customer_category": "salaried",
"first_name": "Neeraj",
"middle_name": "Kumar",
"last_name": "Chopra",
"gender": "m",
"date_of_birth": "1995-12-05",
"age": 26,
"mobile_number": 9876543210,
"email": "minato@gmail.com",
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/update_post_disbursement' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"customer_type": "individual",
"customer_category": "salaried",
"first_name": "Neeraj",
"middle_name": "Kumar",
"last_name": "Chopra",
"gender": "m",
"date_of_birth": "1995-12-05",
Example Response
200 OK
Body
Header(1)
{
"success": true
}
GET
Get Collection Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/payments
GET COLLECTION DETAILS
This API endpoint can be used to get the Payment details.
RESPONSE CODES
Code Message Reason 200 OK Success 401 Unauthorized Invalid API Key 404 Not
found Loan not found 500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/payments' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
View More
[
{
"id": 92135,
"reference_no": null,
"paid_date": "2020-09-22T00:00:00.000Z",
"principal": 50249,
"interest": 502,
"other_charges": 0,
"amount": 50751,
"comment": "Repayment",
"created_at": "2020-09-23T04:26:24.133Z",
POST
Create Collection Entry
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/payments/record_payment
CREATE COLLECTION API
This API endpoint can be used to create a collection entry.
You will get a 201 HTTP response if the collection entry gets created
successfully.
You can even cross verify it by checking the principal outstanding in Loan
Details Response.
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes installment_no
integer true Installment Number 1 [] due_date string date true Due Date for the
Installment (YYYY-MM-DD) 2021-01-02 [] principal number float true Total
principal amount paid for this installment 10000 [] interest number float true
Total interest amount paid for this installement 100 [] other_charges number
float false Other Charges 100 [] overdue_charges number float false Total
overdue interest paid 100 [] penalty_charges number float false Penalty Charges
Paid 100 [] fee_charges number float false Fee Charges Paid 100 []
bounce_charges number float false Bounce charges paid 100 [] amount number float
true Total Collection Amount 10600 [] paid_date string date true Date when
customer paid the amount (YYYY-MM-DD) 2021-01-02 [] investor_transfer_date
string date false Date when originator transferred the amount to investor
(YYYY-MM-DD) 2022-01-02 [] reference_no string true Instrument Number of the
collection received UTR123456 [] instrument_type string false Instrument Type of
the collection received NEFT [] emi_closed string true Y / N. Input Y if the
installment is closed. Y [] foreclosure string true Y / N. Input Y if the loan
is foreclosed. Y [] disbursement_cancellation string false Y / N. Input Y if the
loan disbursement is cancelled. Y [] payment_type string true Normal / Part /
Advance Normal [] pos number float false Before the collection record to mention
pos for that loan 100000 [] updated_rs array false Refer table UpdatedRs for
attributes
[{"installment_no":1,"due_date":"2021-01-02","principal":10000.0,"interest":100.0,"amount":10100.0,"pos":10000.0,"comment":"Payment"},{"installment_no":1,"due_date":"2021-01-02","principal":10000.0,"interest":100.0,"amount":10100.0,"pos":10000.0,"comment":"Payment"}]
UPDATEDRS
Field Type Format Required Description Example Master Codes installment_no
integer true Installment Number 1 [] due_date string date true Due Date for
Installment (YYYY-MM-DD) 2021-01-02 [] principal number float true Total
Principal Amount 10000 [] interest number float true Interest 100 [] amount
number float true Installment amount 10100 [] pos number float true Closing
Principal Outstanding 10000 [] comment string false comment Payment []
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 404 Not found Loan not found 422 Unprocessable
Entity
* Sum of collection payments principal for the installment should be equal to
repayment schedule's principal
* Sum of collection payments interest for the installment should be equal to
repayment schedule's interest
* Amount is not equal to sum of Principal, Interest, Overdue Charges, Other
Charges, Fee Charges, Bounce Charges
* The installment is already paid
* Investor Transfer Date cannot be in the future
* Investor Transfer Date cannot be a Sunday
* Investor transfer date cannot be less than customer transfer date
* Paid date can't be in the future
* Paid date can't be before loan disbursement
* Payment's due date does not match repayment schedule's due date
* Previous cycle is unpaid
* Invalid Loan Status: Loan is not disbursed
500 Internal Server Error Error occurred in the backend
CREATE COLLECTION API
This API endpoint can be used to create a collection entry.
You will get a 201 HTTP response if the collection entry gets created
successfully.
You can even cross verify it by checking the principal outstanding in Loan
Details Response.
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes installment_no
integer true Installment Number 1 [] due_date string date true Due Date for the
Installment (YYYY-MM-DD) 2021-01-02 [] principal number float true Total
principal amount paid for this installment 10000 [] interest number float true
Total interest amount paid for this installement 100 [] other_charges number
float false Other Charges 100 [] overdue_charges number float false Total
overdue interest paid 100 [] penalty_charges number float false Penalty Charges
Paid 100 [] fee_charges number float false Fee Charges Paid 100 []
bounce_charges number float false Bounce charges paid 100 [] amount number float
true Total Collection Amount 10600 [] paid_date string date true Date when
customer paid the amount (YYYY-MM-DD) 2021-01-02 [] investor_transfer_date
string date false Date when originator transferred the amount to investor
(YYYY-MM-DD) 2022-01-02 [] reference_no string true Instrument Number of the
collection received UTR123456 [] instrument_type string false Instrument Type of
the collection received NEFT [] emi_closed string true Y / N. Input Y if the
installment is closed. Y [] foreclosure string true Y / N. Input Y if the loan
is foreclosed. Y [] payment_type string true Normal / Part / Advance Normal []
pos number float false Before the collection record to mention pos for that loan
100000 [] updated_rs array false Refer table UpdatedRs for attributes
[{"installment_no":1,"due_date":"2021-01-02","principal":10000.0,"interest":100.0,"amount":10100.0,"pos":10000.0,"comment":"Payment"},{"installment_no":1,"due_date":"2021-01-02","principal":10000.0,"interest":100.0,"amount":10100.0,"pos":10000.0,"comment":"Payment"}]
UPDATEDRS
Field Type Format Required Description Example Master Codes installment_no
integer true Installment Number 1 [] due_date string date true Due Date for
Installment (YYYY-MM-DD) 2021-01-02 [] principal number float true Total
Principal Amount 10000 [] interest number float true Interest 100 [] amount
number float true Installment amount 10100 [] pos number float true Closing
Principal Outstanding 10000 [] comment string false comment Payment []
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 404 Not found Loan not found 422 Unprocessable
Entity
* Sum of collection payments principal for the installment should be equal to
repayment schedule's principal
* Sum of collection payments interest for the installment should be equal to
repayment schedule's interest
* Amount is not equal to sum of Principal, Interest, Overdue Charges, Other
Charges, Fee Charges, Bounce Charges
* The installment is already paid
* Investor Transfer Date cannot be in the future
* Investor Transfer Date cannot be a Sunday
* Investor transfer date cannot be less than customer transfer date
* Paid date can't be in the future
* Paid date can't be before loan disbursement
* Payment's due date does not match repayment schedule's due date
* Previous cycle is unpaid
* Invalid Loan Status: Loan is not disbursed
500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
{{client_name}}
(Required) Name of the client
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"installment_no": 1,
"due_date": "2021-01-02",
"principal": 10000,
"interest": 100,
"other_charges": 100,
"overdue_charges": 100,
"penalty_charges": 100,
"fee_charges": 100,
"bounce_charges": 100,
"amount": 10600,
201 Created
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/payments/record_payment' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"installment_no": 1,
"due_date": "2021-01-02",
"principal": 10000,
"interest": 100,
"other_charges": 100,
"overdue_charges": 100,
"penalty_charges": 100,
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "LA00175",
"amount": 10330,
"installment_no": 1,
"emi_closed": "N"
}
PUT
Update Collection Entry
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/payments/:payment_id
UPDATE COLLECTION API
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes
investor_transfer_date string date false Date when originator transferred the
amount to investor (YYYY-MM-DD) 2021-02-02 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
payment_id
ref-1269653245
(Required) Payment Reference/Instrument Number as provided during collection
creation
BODYraw
{
"investor_transfer_date": "2021-02-02"
}
200 OK
Example Request
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/payments/ref-1269653245' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"investor_transfer_date": "2021-02-02"
}'
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "agreement_signed"
}
GET
Get Repayment Schedule Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/rs
GET RS DETAILS
This API endpoint can be used to get the repayment schedule details of the loan.
RESPONSE CODES
Code Message Reason 200 OK Success 401 Unauthorized Invalid API Key 404 Not
found Loan not found 500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/rs' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
View More
[
{
"installment_no": "1",
"due_date": "05-09-2019",
"principal": "3193",
"interest": "384",
"emi": "3577",
"pos": "16807"
},
{
"installment_no": "2",
POST
Create Repayment Schedule
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/rs
CREATE REPAYMENT SCHEDULE
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes repayment_schedules
array true Refer table RepaymentSchedules for attributes
[{"installment_no":1,"due_date":"2021-02-02","principal":10000.0,"interest":100.0,"amount":10200.0,"pos":20000.0,"other_charges":100.0},{"installment_no":1,"due_date":"2021-02-02","principal":10000.0,"interest":100.0,"amount":10200.0,"pos":20000.0,"other_charges":100.0}]
REPAYMENTSCHEDULES
Field Type Format Required Description Example Master Codes installment_no
integer true Installment Number 1 [] due_date string date true Due Date for the
Installment (YYYY-MM-DD) 2021-02-02 [] principal number float true Principal to
be paid in the installment 10000 [] interest number float true Interest to be
paid in the installment 100 [] amount number float true Total EMI amount 10200
[] pos number float true Closing Principal Outstanding 20000 [] other_charges
number float false Other Charges 100 []
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 404 Not found Loan not found 412 Pre-condition
failed
* Installment(s) already exists
* Loan disbursement details not present
* Sum of Principal amount in the repayment schedule is not equal to loan's
principal amount
* Number of installments in the repayment schedule should be equal to tenure or
tenure + 1
* First installment date cannot be greater than 60 days from the date of
disbursement
* First installment due date cannot be before loan disbursement date
* Amount is not equal to sum of Principal and Interest
* Invalid installment number
500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
{{client_name}}
(Required) Name of the client
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"repayment_schedules": [
{
"installment_no": 1,
"due_date": "2021-02-02",
"principal": 5000,
"interest": 100,
"amount": 5100,
"pos": 10000,
"other_charges": 0
},
201 Created
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/rs' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"repayment_schedules": [
{
"installment_no": 1,
"due_date": "2021-02-02",
"principal": 10000,
"interest": 100,
"amount": 10200,
Example Response
200 OK
Body
Header(1)
View More
{
"client_loan_id": "AB001",
"repayment_schedules": [
{
"installment_no": "1",
"due_date": "05-09-2019",
"principal": "3193",
"interest": "384",
"emi": "3577",
"pos": "16807"
},
PUT
Update Repayment Schedule
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/rs
UPDATE REPAYMENT SCHEDULE API
This endpoint can be used to update the repayment schedules.
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes repayment_schedules
array true Refer table RepaymentSchedules for attributes
[{"installment_no":1,"due_date":"2021-01-01","principal":10000.0,"interest":100.0,"amount":10200.0,"pos":100000.0,"other_charges":100.0},{"installment_no":1,"due_date":"2021-01-01","principal":10000.0,"interest":100.0,"amount":10200.0,"pos":100000.0,"other_charges":100.0}]
REPAYMENTSCHEDULES
Field Type Format Required Description Example Master Codes installment_no
integer false Installment Number 1 [] due_date string date false Installment Due
Date (YYYY-MM-DD) 2021-01-01 [] principal number float false Principal to be
paid in the installment 10000 [] interest number float false Interest to be paid
in the installment 100 [] amount number float false Total EMI amount 10200 []
pos number float false Closing principal outstanding 100000 [] other_charges
number float false Other Charges 100 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"repayment_schedules": [
{
"installment_no": 1,
"due_date": "2021-01-01",
"principal": 10000,
"interest": 100,
"amount": 10200,
"pos": 100000,
"other_charges": 100
},
200 OK
Example Request
View More
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/rs' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"repayment_schedules": [
{
"installment_no": 1,
"due_date": "2021-01-01",
"principal": 10000,
"interest": 100,
"amount": 10200,
Example Response
200 OK
Body
Header(1)
View More
[
{
"installment_no": "1",
"due_date": "05-09-2019",
"principal": "3193",
"interest": "384",
"emi": "3577",
"pos": "16807"
},
{
"installment_no": "2",
POST
Create Advance Collection
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/advance_payments
ADVANCE COLLECTION API
This endpoint can be used to create an advance transaction for a loan that can
be utilized in future payments later
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes amount number float
true Advance Amount 10000 [] transaction_date string date true Date when
customer paid the amount (YYYY-MM-DD) 2021-01-02 [] investor_transfer_date
string date false Date when originator transferred the amount to investor
(YYYY-MM-DD) 2021-01-02 [] instrument_number string true UTR / Cheque Number
UTR12345 [] instrument_type string false RTGS / NEFT / UPI / Cheque NEFT []
advance_outstanding number float true Before this collection record to mention
advance outstanding for that loan 5000 [] transaction_type string true Credit /
Refund Credit [] comment string false comment Advance payment []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
BODYraw
{
"amount": 10000,
"transaction_date": "2021-01-02",
"investor_transfer_date": "2021-01-02",
"instrument_number": "UTR12345",
"instrument_type": "NEFT",
"advance_outstanding": 5000,
"transaction_type": "Credit",
"comment": "Advance payment"
}
200 OK
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/advance_payments' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"amount": 10000,
"transaction_date": "2021-01-02",
"investor_transfer_date": "2021-01-02",
"instrument_number": "UTR12345",
"instrument_type": "NEFT",
"advance_outstanding": 5000,
"transaction_type": "Credit",
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "agreement_signed"
}
PUT
Update Advance Collection
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/advance_payments/:advance_payment_id
UPDATE ADVANCE COLLECTION API
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes
investor_transfer_date string date false Date when originator transferred the
amount to investor (YYYY-MM-DD) 2017-01-02 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
loan_id
AB001
(Required) Client Loan ID as provided during loan creation
advance_payment_id
1276
(Required) Advance Payment ID returned in Create Advance API
BODYraw
{
"investor_transfer_date": "2017-01-02"
}
200 OK
Example Request
curl --location --request PUT 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/AB001/advance_payments/1276' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"investor_transfer_date": "2017-01-02"
}'
Example Response
200 OK
Body
Header(1)
{
"success": true
}
POST
Upload Interest Accruals
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/interest_accruals
UPLOAD INTEREST ACCRUALS API
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes file_link string
true Interest Accrual File URL
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg []
file_link_password string false Interest Accrual File URL 12345678 []
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
BODYraw
{
"file_link": "https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"file_link_password": "12345678"
}
200 OK
Example Request
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/interest_accruals' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"file_link": "https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"file_link_password": "12345678"
}'
Example Response
200 OK
Body
Header(1)
{
"success": true
}
GET
Get Interest Accrual
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/interest_accruals/:file_id
GET INTEREST ACCRUAL API
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
file_id
1
(Required) File ID returned in the response of upload interest accrual
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/interest_accruals/1' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
{
"client_loan_id": "AB001",
"status": "agreement_signed"
}
POST
Upload File (Bulk Create)
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/files
UPLOAD INTEREST ACCRUALS API
REQUEST PARAMETERS
Field Type Format Required Description Example Master Codes file_type string
true Type of file collection [collection, repayment_schedule] file_link string
true Interest Accrual File URL
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg []
file_link_password string false Interest Accrual File URL 12345678 []
dependent_file_link string true Dependent File for processing collection
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg []
dependent_file_link_password string false Password of Dependent File for
processing collection 12345678 []
RESPONSE CODES
View More
Code Message Reason 201 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
Key
<key>
Value
{{client_api_key}}
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
Content-Type
application/json
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
BODYraw
{
"file_type": "collection",
"file_link": "https://int-colend-documents-ap-south-1-090228812041.credavenue.in/customer_file/19261/3d11aef9daec8b7a72a271ed7ea5d5ae.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARKAQONEEUX4USU23%2F20220121%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220121T051540Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmFwLXNvdXRoLTEiRjBEAiA66smGdNMUHTChIjUMQavn4kZTv8QPjldCKxv%2FVQOp5AIgMyvIM0mwqgKLryxkKwIrLYR4rFMJIfEO6111nBUBG2Mq9AMIJRACGgwwOTAyMjg4MTIwNDEiDDiqnh03X7MhRRNDsCrRA4rYIW%2F%2BPaoTxuo0SATkwUeaa24gvcxQZbt%2Fbtf%2FZJesMLZZOcy92tOpQM7NwXq3ukANUUkMbJFdLFUHOXSMlqI3OMeH6m3jJ%2B8rB0%2FXDPkUDVHwTT1IE6h%2B0DTZwAHI2bgZzMrrhYL7WFJK0JEvs%2FnoWqpHPKRCZQ7%2BsDZkBKhv8qqstfJGyLlCqli8aBps5nI9aaCvazoipjOfdA4N5S7hSKxqLb7Y3Ce1XmctD8SHjtxy%2FpBCQwDdeDB7xLDlbQZRDb48m%2BT7DEhE%2B%2Fp0wUqzwFfl5%2Fj0loZWwL%2BlXtmqHLf3xfzCh9wdicPiWoiOC49t%2F7cgASjwjLtTCdJj3mBVhAZeC%2BMoozOH6NxVtF2zsk13HvDvb57e%2FWb0QCuNx7RE4LMc0qad1VnD3JLnMUjXgvaMxkakaD62ByOYI9h2%2FcIJ0GYFDgF6lRuVVTSNmWYUPzpecz9YpgTfh4MZM%2FjMz0iSZ5yzBadA%2Bk1xXwVS9zNd8kpiq6ErCNfjpB4RAxKn5R2NUSfFG1ok5QwbxV4GHxQk1leWkgEhtL4HkX9A%2FHi6KnTnqsUcoQLXueWGBNWo3ho59Pr7wOQpyQ87LmpYf1OBE%2FeIpr0eOVlFTrpdETCGzqiPBjqmAa%2FtdmXLkNieVEiFBRMaz%2F6rq2Hoo5JLNcS9V0f5TB2c3lcoS0n3oLPRyi2AgPLetghJHKfNTasvqTzUZAIex%2Bd7%2BQ%2F3NKT4HlG7jxHXQ9fJhjKov7wLw%2FkjD2VGpzpY7JNVxspRERZ6%2FTH0p3rYDYrqJtGY2F2NPywGMNqA%2FezLcFUbEbDYj%2BjBfBM9R3art1Q%2FlmIIvNtEnxZQvYU2HfQasPbLsYA%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=674f0c70cf9ece70d738c24df90ff0ad69672d7a1c5e073f780206394d5a70c1",
"dependent_file_link": "https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"
}
200 OK
Example Request
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/interest_accruals' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001' \
--data-raw '{
"file_link": "https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
}'
Example Response
200 OK
Body
Header(1)
View More
{
"id": 19055,
"name": "standard_loan_template.xlsx",
"status": "processed",
"no_of_loans": 0,
"added_loans": 0,
"failed_loans": 0,
"amount": 0,
"report": {
"id": "59e6e045b65cb7946c8c20b2ecf424fb",
"name": "19055_report.csv",
GET
Get File Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/files/:file_id
GET INTEREST ACCRUAL API
RESPONSE CODES
View More
Code Message Reason 204 No content Success 401 Unauthorized Invalid API Key 400
Bad Request
* Failed due to invalid request format
* Missing required parameters
* Loan is in invalid state
404 Not found Loan not found 500 Internal Server Error Error occurred in the
backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
UPMONE_CREDITLINE
(Required) Product Code given by CoLending
PATH VARIABLES
client_name
upmoney_
(Required) Name of the client
file_id
1
200 OK
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/interest_accruals/19055' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
View More
{
"id": 19055,
"name": "standard_loan_template.xlsx",
"status": "processed",
"no_of_loans": 0,
"added_loans": 0,
"failed_loans": 0,
"amount": 0,
"report": {
"id": "59e6e045b65cb7946c8c20b2ecf424fb",
"name": "19055_report.csv",
POST
Create Tranche
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/tranches
CREATE TRANCHE
This API endpoint can be used to create a tranche.
REQUEST PARAMETERS
View More
Field Type Format Required Description Example Master Codes tranche_number
integer true Tranche Number 1 [] principal_amount integer true Principal amount
to be disbursed in the tranche 100000 [] differential_interest integer false
Broken period interest amount 100 [] interest_start_date string date false Pre
Emi interest due date 2021-01-01 [] processing_fee integer false Processing fee
amount (Inckusive of GST) 100 [] stamp_duty integer false Stamp duty amount 100
[] insurance_charges integer false Insurance premium inclusive of GST 100 []
documentation_charges integer false Total documentation charges inclusive of GST
100 [] other_charges integer false Any other charges inclusive of GST 100 []
closing_loan_principal integer true Balance principal amount after this tranche
100000 [] tranche_doc_link array false Link to the corresponding document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tranche_doc_link_password string false Link to the corresponding document
12345678 [] disbursement_accounts array false Refer table DisbursementAccounts
for attributes
[{"bank_name":"HDFC","bank_account_type":"savings","account_name":"Arya","bank_branch_name":"Nandanam","ifsc_code":"HDFC0000123","entity_type":"dealer","account_no":987656453423,"amount":1000000},{"bank_name":"HDFC","bank_account_type":"savings","account_name":"Arya","bank_branch_name":"Nandanam","ifsc_code":"HDFC0000123","entity_type":"dealer","account_no":987656453423,"amount":1000000}]
borrower_data object Refer table BorrowerData for attributes
{"pan_number":"POIUY1234H","pan_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"pan_number_link_password":"12345678","form_60_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"form_60_link_password":"12345678","aadhar_number":"987612345432","aadhar_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"aadhar_number_link_password":"12345678","voter_id_number":"RTG2291234","voter_id_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"voter_id_number_link_password":"12345678","driving_license_number":"TN0112345","driving_license_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"driving_license_number_link_password":"12345678","passport_number":"L4018345","passport_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"passport_number_link_password":"12345678","video_image_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"video_image_link_password":"12345678","video_kyc_detail":"{"profile_id":"ABC12345","account_id":"ABC12345","key":"abc@123"}","other_kyc_number":"ABC12345","other_kyc_number_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_kyc_number_link_password":"12345678","rent_agreement_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"rent_agreement_link_password":"12345678","utility_bills_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"utility_bills_link_password":"12345678","photo_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"photo_link_password":"12345678","employer_tier":"tier1","employment_type":"salaried","employment_details_name":"Credavenue","employment_details_address":"221B,
Baker Street,
Chennai","employment_details_years_of_experience":3.0,"employment_details_designation":"IT
Consultant","employement_vintage_current_organisation":"3","payslip_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"payslip_link_password":"12345678","tds_certificate_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"tds_certificate_link_password":"12345678"}
bureau_report_data object Refer table BureauReportData for attributes
{"name_of_bureau":"cibil","bureau_vintage":3,"bureau_score":650,"bureau_report_json_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"bureau_report_json_link_password":"12345678","commercial_bureau_score":330,"commercial_bureau_score_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"commercial_bureau_score_link_password":"12345678","partner_score_on_the_customer_including_bureau_report":800,"total_existing_obligations":25000,"credit_card_limit":30000,"no_of_credit_cards":3,"total_number_of_unsecured_loans":2,"value_of_total_unsecured_loans":20000.0,"total_number_of_loans":2,"value_of_total_loans":20000.0,"number_of_enquiries_3months":3,"number_of_enquiries_6months":3,"number_of_enquiries_12months":4,"number_of_writeoff_suitfiled_settled_in_the_last_12_months":4,"max_dpd_tradeline_last_12months":6,"max_overdue_tradeline":6,"total_overdue_amount_in_last_12m":10000.0,"amount_of_loan_settled_in_last_12m":25000.0,"nature_of_loan_settled1":"settled","nature_of_loan_settled2":"closed","total_emi_bounces":3,"bounces_in_last_6m":3,"bounces_in_last_12m":3}
client_loan_id string true Loan ID as per Partner's LMS LOAN00001 [] loan_data
object Refer table LoanData for attributes
{"principal_amount":100000.0,"interest_rate":14.0,"tenure":2,"tenure_frequency":"monthly","repayment_frequency":0.0,"number_of_repayments":2}
business_data object Refer table BusinessData for attributes
{"business_pan_number":"BMMPG9018G","business_pan_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_pan_link_password":"12345678","business_rc_number":"U72200MH2009PLC123456","business_rc_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_rc_link_password":"12345678","business_gst_number":"29ABCDE1234F2Z5","business_gst_copy_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_gst_copy_link_password":"12345678","business_udyog_aadhar_number":"794065346725","business_udyog_aadhar_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_udyog_aadhar_link_password":"12345678","business_ssi_number":"7589297314","business_ssi_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_ssi_link_password":"12345678","business_shops_est_number":"2017086025","business_shops_est_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_shops_est_link_password":"12345678","business_factory_regn_number":"TVEIQ0615232","business_factory_regn_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_factory_regn_link_password":"12345678","business_trade_license_number":"EA131102014709112","business_trade_license_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_trade_license_link_password":"12345678","business_place_photo_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_place_photo_link_password":"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","business_continuity_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"business_continuity_proof_link_password":"12345678","other_business_address_proof_number":"ABC12345","other_business_address_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_business_address_proof_link_password":"12345678","no_of_business_authorised_persons":"3","partnership_detail":"{"partnership_firm_pan":"BMMPG9018G","partnership_pan_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partnership_pan_link_password":"12345678","partnership_deed_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partnership_deed_link_password":"12345678","beneficiary_owner_details_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"beneficiary_owner_details_link_password":"12345678"}","private_entity_detail":"{"cin_number":"L21091KA2019OPC141331","cin_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cin_link_password":"12345678","moa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"moa_link_password":"12345678","aoa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"aoa_link_password":"12345678","board_resoultion_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"board_resoultion_link_password":"12345678","share_holding_pattern_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"share_holding_pattern_link_password":"12345678","other_company_proof":"ABC12345","other_company_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_company_proof_link_password":"12345678"}"}
DISBURSEMENTACCOUNTS
View More
Field Type Format Required Description Example Master Codes bank_name string
true Name of the bank where disbursement needs to be done HDFC []
bank_account_type string true Account type - Savings/Current/Overdraft/CC
savings ["savings", "current", "overdraft", "cc"] account_name string true Bank
account name where disbursement needs to be done Arya [] bank_branch_name string
true Bank branch name where disbursement needs to be done Nandanam [] ifsc_code
string true Bank IFSC wheredisbursement needs to be done HDFC0000123 []
entity_type string true dealer / sub_dealer / originator / existing_lender /
end_customer dealer ["dealer", "sub_dealer", "originator", "existing_lender",
"end_customer"] account_no integer true Account number of bank where
disbursement needs to be done 987656453423 [] amount integer true Amount to be
transferred to particular Vendor/borrower 1000000 []
VIDEOKYCDETAIL
Field Type Format Required Description Example Master Codes profile_id string
false Required if video KYC is done. Profile ID of the case as per the video KYC
vendor ABC12345 [] account_id string false Required if video KYC is done.
Account ID of the case as per the video KYC vendor ABC12345 [] key string false
Required if video KYC is done. Key as per the video KYC vendor abc@123 []
BORROWERDATA
View More
Field Type Format Required Description Example Master Codes pan_number string
false PAN Number of the Customer (10 digit Alphanumeric) POIUY1234H []
pan_number_link array false PAN Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
pan_number_link_password string false PAN Document Link 12345678 [] form_60_link
array false Form 60 Doument Link (If applicable)
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
form_60_link_password string false Form 60 Doument Link Password (If applicable)
12345678 [] aadhar_number string false Aadhar Number of the Customer (12 digits)
987612345432 [] aadhar_number_link array false Aadhar Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aadhar_number_link_password string false Aadhar Document Link 12345678 []
voter_id_number string false Voter ID Number of the Customer RTG2291234 []
voter_id_number_link array false Voter Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
voter_id_number_link_password string false Voter Document Link 12345678 []
driving_license_number string false Driving License Number of the Customer
TN0112345 [] driving_license_number_link array false Driving License Document
Link ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
driving_license_number_link_password string false Driving License Document Link
12345678 [] passport_number string false Passport Number of the Customer
L4018345 [] passport_number_link array false Passport Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
passport_number_link_password string false Passport Document Link 12345678 []
video_image_link array false Video Image of the Applicant
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
video_image_link_password string false Video Image of the Applicant 12345678 []
video_kyc_detail object Refer table VideoKycDetail for attributes
{"profile_id":"ABC12345","account_id":"ABC12345","key":"abc@123"}
other_kyc_number string false KYC Number of the Customer ABC12345 []
other_kyc_number_link array false KYC Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_kyc_number_link_password string false KYC Image of the Customer 12345678
[] rent_agreement_link array false Rent Agreement Document Link
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
rent_agreement_link_password string false Rent Agreement Document Link 12345678
[] utility_bills_link array false Utility Bills Copies (If any)
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
utility_bills_link_password string false Utility Bills Copies (If any) 12345678
[] photo_link array false Photo Image of the Customer
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
photo_link_password string false Photo Image of the Customer 12345678 []
employer_tier string false tier1, tier2 etc. for the employer tier1 []
employment_type string false Salaried / Self-Employed salaried []
employment_details_name string false Employer Name Credavenue []
employment_details_address string false Office Address 221B, Baker Street,
Chennai [] employment_details_years_of_experience number float false Applicant's
years of experience in the current organization 3 []
employment_details_designation string false Applicant's Current Designation IT
Consultant [] employement_vintage_current_organisation string false Vintage 3 []
payslip_link array false Last 3 Months Payslips
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
payslip_link_password string false Last 3 Months Payslips 12345678 []
tds_certificate_link array false Last 3 Years TDS Certificate
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
tds_certificate_link_password string false Last 3 Years TDS Certificate 12345678
[]
BUREAUREPORTDATA
View More
Field Type Format Required Description Example Master Codes name_of_bureau
string false Cibil / Experian / Himark cibil [] bureau_vintage integer false
Vintage in the bureau. Number of years from the first trade line 3 []
bureau_score integer false Bureau Score 650 [] bureau_report_json_link array
false Document of the bureau
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
bureau_report_json_link_password string false Document of the bureau - Password
12345678 [] commercial_bureau_score integer false CRIF score 330 []
commercial_bureau_score_link array false Commercial Bureau Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
commercial_bureau_score_link_password string false Commercial Bureau Document
Password 12345678 [] partner_score_on_the_customer_including_bureau_report
integer false Score Captured by the Partner 800 [] total_existing_obligations
integer false Total Existing Obligations basis the Bureau Report 25000 []
credit_card_limit integer false Total Credit Card Limit basis the Bureau Report
30000 [] no_of_credit_cards integer false Total Number of Credit Cards per
Bureau Report 3 [] total_number_of_unsecured_loans integer false Total Number of
Unsecured Loans per Bureau Report 2 [] value_of_total_unsecured_loans number
float false Total value of unsecured loans 20000 [] total_number_of_loans
integer false Total Number of Loans per Bureau Report 2 [] value_of_total_loans
number float false Total value of loans 20000 [] number_of_enquiries_3months
integer false Number of Enquiries in the Last 3 Months per Bureau Report 3 []
number_of_enquiries_6months integer false Number of Enquiries in the Last 6
Months per Bureau Report 3 [] number_of_enquiries_12months integer false Number
of Enquiries in the Last 12 Months per Bureau Report 4 []
number_of_writeoff_suitfiled_settled_in_the_last_12_months integer false Number
of Writeoff Suitfiled Settled in the Last 12 Months 4 []
max_dpd_tradeline_last_12months integer false Maximum DPD Tradeline in the Last
12 Months 6 [] max_overdue_tradeline integer false Maximum Overdue Tradeline 6
[] total_overdue_amount_in_last_12m number float false Total Overdue Amount in
the Last 12 Months 10000 [] amount_of_loan_settled_in_last_12m number float
false Loan Amount Settled in the Last 12 Months 25000 [] nature_of_loan_settled1
string true The nature of past loan settlement if any (Loan 1) - Settled/
Closed/ Written-off settled [] nature_of_loan_settled2 string true The nature of
past loan settlement if any (Loan 2) - Settled/ Closed/ Written-off closed []
total_emi_bounces integer false Total EMI Bounces 3 [] bounces_in_last_6m
integer false EMI Bounces in the Last 6 Months 3 [] bounces_in_last_12m integer
false EMI Bounces in the Last 12 Months 3 []
LOANDATA
Field Type Format Required Description Example Master Codes principal_amount
number float false Total loan amount in Rs (Overall amount to the borrower)
100000 [] interest_rate number float false Reducing balance Interest rate of the
customer in %. This is the interest rate to be mentioned in the sanction letter
as well 14.0 [] tenure integer false Tenure of the loan 2 [] tenure_frequency
string false Whehter the tenure is monthly/yearly/weekly monthly []
repayment_frequency number float false Daily/Weekly/Once in 2
weeks/Monthly/Quarterly/Bullet Monthly [] number_of_repayments integer false
Number of repayments as per the repayment schedule 2 []
PARTNERSHIPDETAIL
View More
Field Type Format Required Description Example Master Codes partnership_firm_pan
string false PAN number of partnership BMMPG9018G [] partnership_pan_link array
false PAN image of partnership
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
partnership_pan_link_password string false PAN image password of partnership
12345678 [] partnership_deed_link array false Partnership deed image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
partnership_deed_link_password string false Partnership deed image password
12345678 [] beneficiary_owner_details_link array false Shareholding pattern of
the firm
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
beneficiary_owner_details_link_password string false Shareholding pattern of the
firm - password 12345678 []
PRIVATEENTITYDETAIL
View More
Field Type Format Required Description Example Master Codes cin_number string
false CIN number in case of a company L21091KA2019OPC141331 [] cin_link array
false CIN image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
cin_link_password string false CIN image password 12345678 [] moa_link array
false MOA image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
moa_link_password string false MOA image password 12345678 [] aoa_link array
false AOA image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
aoa_link_password string false AOA image password 12345678 []
board_resoultion_link array false Board resolution image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
board_resoultion_link_password string false Board resolution image password
12345678 [] share_holding_pattern_link array false Shareholding pattern image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
share_holding_pattern_link_password string false Shareholding pattern image
password 12345678 [] other_company_proof string false Free flowing text ABC12345
[] other_company_proof_link array false Image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_company_proof_link_password string false Image password 12345678 []
BUSINESSDATA
View More
Field Type Format Required Description Example Master Codes business_pan_number
string false PAN number of business BMMPG9018G [] business_pan_link array false
PAN image of business
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_pan_link_password string false PAN image password of business 12345678
[] business_rc_number string false Registration number of the business
U72200MH2009PLC123456 [] business_rc_link array false Image of the RC
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_rc_link_password string false Image password of the RC 12345678 []
business_gst_number string false Business GST number 29ABCDE1234F2Z5 []
business_gst_copy_link array false Business GST image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_gst_copy_link_password string false Business GST image password
12345678 [] business_udyog_aadhar_number string false 794065346725 []
business_udyog_aadhar_link array false Business Udyog Aadhar Document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_udyog_aadhar_link_password string false Business Udyog Aadhar Document
Password 12345678 [] business_ssi_number string false Small scall industries
registration number 7589297314 [] business_ssi_link array false Small scall
industries registration document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_ssi_link_password string false Small scall industries registration
document password 12345678 [] business_shops_est_number string false Shop
establishment number 2017086025 [] business_shops_est_link array false Shop
establishment document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_shops_est_link_password string false Shop establishment document
password 12345678 [] business_factory_regn_number string false Factory
riegistration number TVEIQ0615232 [] business_factory_regn_link array false
Factory riegistration document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_factory_regn_link_password string false Factory riegistration document
password 12345678 [] business_trade_license_number string false Trade license
number EA131102014709112 [] business_trade_license_link array false Trade
license document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_trade_license_link_password string false Trade license document
password 12345678 [] business_place_photo_link array false Business place photo
image ["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_place_photo_link_password string false Business place photo image
https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg []
business_continuity_proof_link array false Business continuity proof document
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
business_continuity_proof_link_password string false Business continuity proof
document password 12345678 [] other_business_address_proof_number string false
any other adddress proof number ABC12345 [] other_business_address_proof_link
array false any other adddress proof image
["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg",
"https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"]
other_business_address_proof_link_password string false any other adddress proof
image password 12345678 [] no_of_business_authorised_persons string false Number
of authorized person for business 3 [] partnership_detail object Refer table
PartnershipDetail for attributes
{"partnership_firm_pan":"BMMPG9018G","partnership_pan_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partnership_pan_link_password":"12345678","partnership_deed_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"partnership_deed_link_password":"12345678","beneficiary_owner_details_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"beneficiary_owner_details_link_password":"12345678"}
private_entity_detail object Refer table PrivateEntityDetail for attributes
{"cin_number":"L21091KA2019OPC141331","cin_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"cin_link_password":"12345678","moa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"moa_link_password":"12345678","aoa_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"aoa_link_password":"12345678","board_resoultion_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"board_resoultion_link_password":"12345678","share_holding_pattern_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"share_holding_pattern_link_password":"12345678","other_company_proof":"ABC12345","other_company_proof_link":["https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg","https://cdn.pixabay.com/photo/2017/06/22/20/22/green-2432374_1280.jpg"],"other_company_proof_link_password":"12345678"}
RESPONSE CODES
View More
Code Message Reason 201 Created Success 400 Bad Request
* Invalid request format
* Missing required params
401 Unauthorized Invalid API Key 422 Unprocessable Entity
* Tranche Number Already Taken
* Loan Not Found
* Document not found/accessible
500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Content-Type
application/json
Product-Id
UPMONE_CREDITLINE
PATH VARIABLES
client_name
{{client_name}}
loan_id
{{loan_id}}
(Required) Client Loan ID as provided during loan creation
BODYraw
View More
{
"tranche_number": 2,
"principal_amount": 5000,
"differential_interest": 100,
"interest_start_date": "2021-01-01",
"processing_fee": 100,
"stamp_duty": 100,
"insurance_charges": 100,
"documentation_charges": 100,
"other_charges": 100,
"closing_loan_principal": 100000,
200 OK
Example Request
View More
curl --location --request POST 'https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/AB001/tranches' \
--header 'Api-Key: <API Key>' \
--data-raw '{
"tranche_number": 1,
"principal_amount": 100000,
"differential_interest": 100,
"interest_start_date": "2021-01-01",
"processing_fee": 100,
"stamp_duty": 100,
"insurance_charges": 100,
"documentation_charges": 100,
Example Response
200 OK
Body
Header(1)
View More
{
"tranche_number": 1,
"principal_amount": 100000,
"differential_interest": 100,
"interest_start_date": "2021-01-01",
"processing_fee": 100,
"stamp_duty": 100,
"insurance_charges": 100,
"documentation_charges": 100,
"other_charges": 100,
"closing_loan_principal": 100000,
GET
Get Tranche Details
https://colend-uat-01-api.credavenue.in/colending/clients/:client_name/api/v2/loans/:loan_id/tranches/:id
GET TRANCHE DETAILS
This API endpoint can be used to get the tranche details of loan.
RESPONSE CODES
Code Message Reason 200 OK Success 401 Unauthorized Invalid API Key 404 Not
found Loan not found 500 Internal Server Error Error occurred in the backend
AUTHORIZATIONAPI Key
This request is using API Key from collectionDreamplug (Cred <> Cred Avenue
Workflow)
HEADERS
Product-Id
XYZ_001
(Required) Product Code given by CoLending
PATH VARIABLES
host
https://colend-uat-01-api.credavenue.in/colending
For UAT environment
client_name
dreamplug
(Required) Name of the client
id
98050917.95801479
(Required) Tranche Number of Loan
response
Example Request
curl --location --request GET 'https://colend-uat-01-api.credavenue.in/colending/clients/dreamplug/api/v2/loans/:loan_id/tranches/98050917.95801479' \
--header 'Api-Key: <API Key>' \
--header 'Product-Id: XYZ_001'
Example Response
200 OK
Body
Header(1)
No response body
This request doesn't return a response body