API SPECIFICATIONS
API Documentation for Bulk Upload Data
Table of Content
Description
This API is used to upload loan bulk data based on loan ID. It supports two data options:
appending new entries or editing existing data
completely removing existing data to overwrite with new data.
Below are the details for the API URL, headers for authentication, body parameters, and the success and failure responses along with a sample payload.
API Endpoint
Headers
apiKey: <PROVIDED_API_KEY>
apiSecretKey: <PROVIDED_API_SECRET_KEY>
Body Parameters
Key | Type | Remark |
data | Array Of Objects | See sample payload below. |
Responses
Success (201)
If any error occurred then an Array of object(s) will be provided which may consist of loan_id, row, and notAvailable property.
Key | Value |
status | “success” |
message | Data uploaded successfully! |
data | validData: [{ lanId: <loan_id> }] inValidData: [ { lanId: loan_Id, row: <row_number in which the error occurred>, notAvailabe: [{ header: <headerName>, reason: <reason why this field got rejected> }] } ] |
Error Responses
If apiKey and apiSecretKey not provided
Key | Value |
status | “Fail” (400) |
message | "Invalid API Key or Secret! Please contact Admin!” |
If apiKey isn’t correct
Key | Value |
status | “Fail” (404) |
message | "Invalid API Key! Please contact Admin!” |
If intake form hasn’t been created
Key | Value |
status | “Fail” (404) |
message | "No In-Take Form Found! Please insert in-take form detail(s) first” |
If no data provided
Key | Value |
status | “Fail” (404) |
message | "No Data Provided!” |
6. Sample Payload
{
"data": [
{
"agreement_no": "1",
"branch_name": "Branch A",
"loan_type": "Car",
"complete_address": "21/A Sector 44 Gurugram",
"pincode": "110038",
"state": "Haryana",
"agreement_date": "31-01-2024",
"last_payment_date": "30-31-2023",
"arrears_in_amount": "4000",
"dpd": "30",
"principal_outstanding": "1000",
"intrest": "20",
"vas_charges": "",
"applicant_name": "Himanshu Nainwal",
"applicant_father_name": "Himanshu",
"primary_address": "21/A Sector 44 Gurugram",
"secondary_address": "",
"contact_number": "9717729040",
"coapplicant1_name": "akakaka",
"coapplicant1_Father_name": "",
"coapplicant1_address": "",
"coapplicant1_secondary_address": "",
"coapplicant1_mobile": "9717729040",
"coapplicant2_name": "",
"coapplicant2_Father_name": "",
"coapplicant2_address": "",
"coapplicant2_mobile": "",
"coapplicant2_secondary_address": "34/B Sector 24 Dwarka",
"lpi": "45",
}
]
}