Fetch Collateral Details for Loan Id
GET Collateral form Loan Id
This Synofin API retrieves all the essential Collateral information using this Loan Viewer API using Loan Id.
URL: {{base_url}}/loan-management/v1/getCollaterals
Run in Postman: GET Loan Collaterals
Request:
Request Type: GET
Authorization: Bearer Token
Query Parameter:
Key | Data Type | Description | Validations | Default Value | Required |
loanId | Integer | Unique identity constraint | N/A | - | Yes |
Response:
Success: 200 OK
Schema
Attribute |
Type | Description | Mandatory | ||
response | Boolean | ||||
data | Object | ||||
<Collateral> | Object | ||||
description | String | ||||
address | String | ||||
pincode | Integer | ||||
remarks | String | ||||
identifier | String | ||||
longitude | Number | ||||
longitude | Number | ||||
capacity | String | ||||
status | String | ||||
marking | String | ||||
country | String | ||||
region | String | ||||
state | String | ||||
city | String | ||||
district | String | ||||
taluka | String | ||||
village | String | ||||
collateral_id | Integer | ||||
cersai_score | Integer | ||||
loan_id | Integer | ||||
is_building_constructed | Boolean | ||||
built_up_area | String | ||||
carpet_area | String | ||||
age_of_property | integer | ||||
residual_age_of_property | integer | ||||
plot_number | Integer | ||||
seller_name | String | ||||
present_registered_owner | String | ||||
tct_no | String | ||||
lot_no | String | ||||
percentage_share | String | ||||
is_property_registered_in_favour_of_borrower | Boolean | ||||
registration_number | String | ||||
agreement_value | String | ||||
amenities_agreement_value | String | ||||
owner_name | String | ||||
ownership_percentage_share | String | ||||
policy_note_number | String | ||||
insurance_company_name | String | ||||
insurance_term | String | ||||
coverage_amount | Number | ||||
premium_amount | Number | ||||
insurance_deviation_details | String | ||||
cersai_txn_ref_no | String | ||||
cersai_security_interest_id | String | ||||
cersai_no_of_borrowers | String | ||||
cersai_no_of_documents | String | ||||
cersai_no_of_third_parties | String | ||||
country_string | String | ||||
region_string | String | ||||
state_string | String | ||||
city_string | String | ||||
district_string | String | ||||
taluka_string | String | ||||
village_string | String | ||||
karat_value | String | ||||
gross_weight | Integer | ||||
net_weight | Integer | ||||
rf_id | String | ||||
collateral_product | String | ||||
installer_name | String | ||||
installer_gstno | String | ||||
installer_address | String | ||||
installer_city | String | ||||
installer_state | String | ||||
installer_pincode | String | ||||
installer_district | String | ||||
installer_id | String | ||||
cost_of_asset | Double | ||||
pv_module_model | String | ||||
pv_module_make | String | ||||
inverter_model | String | ||||
inverter_make | String | ||||
asset_type | String | ||||
vehicle_type | String | ||||
manufacturer | String | ||||
product | String | ||||
model | String | ||||
chasis_no | String | ||||
dealer_name | String | ||||
dealer_address | String | ||||
dealer_city | String | ||||
dealer_state | String | ||||
dealer_pincode | String | ||||
policy_cover_note_number | String | ||||
insurance_company | String | ||||
start_date_disburse_date | String | ||||
coverage_type | String | ||||
ownership_status | String | ||||
installer_address_json | JSON | ||||
vehicle_registration_no | String | ||||
engine_no | String | ||||
global_collateral_identifier | String | ||||
property_information | String | ||||
land_type | String | ||||
land_area | Integer | ||||
model_year | Integer | ||||
gross_total | Double | ||||
total_discount | Double | ||||
total_tax | Double | ||||
total_invoice_amount | Double | ||||
invoice_line_item | String | ||||
sub_registrar | String | ||||
carpet_up_area_unit | Double | ||||
built_up_area_unit | Double | ||||
collateral_type | String | ||||
collateral_subtype | String | ||||
repossession_status | String | ||||
property_type | String | ||||
nature_of_property | String | ||||
market_value | Double | ||||
property_classification | String | ||||
property_ownership | String | ||||
property_purpose | String | ||||
address_type | String | ||||
current_usage | String | ||||
agreement_type | String | ||||
sale_deed_date | Date | ||||
ownership_dates | Date | ||||
disbursal_date | Date | ||||
cersai_security_interest_creation_date | Date | ||||
collateral_document | String | ||||
insurance_start_date | Date | ||||
insurance_end_date | Date | ||||
valuation_date_of_asset | Date | ||||
property_usage | String | ||||
hypothecation_status | String | ||||
s_no | Integer | ||||
owner_father_name | String | ||||
previous_financer | String | ||||
dealer_payment_mode | String | ||||
dealer_bank_account_number | String | ||||
dealer_contact_number | String | ||||
Body
{
"response": true,
"data": {
"<Collateral>": {
"description": "string",
"address": "string",
"pincode": 0,
"remarks": "string",
"identifier": "string",
"longitude": 0,
"latitude": 0,
"capacity": "string",
"status": null,
"marking": null,
"country": null,
"region": null,
"state": "string",
"city": null,
"district": "string",
"taluka": "string",
"village": "string",
"collateral_id": 0,
"cersai_score": null,
"loan_id": 0,
"is_building_constructed": null,
"built_up_area": "string",
"carpet_area": "string",
"age_of_property": null,
"residual_age_of_property": null,
"plot_number": null,
"seller_name": null,
"present_registered_owner": null,
"tct_no": null,
"lot_no": null,
"percentage_share": null,
"is_property_registered_in_favour_of_borrower": null,
"registration_number": null,
"agreement_value": null,
"amenities_agreement_value": null,
"owner_name": "string",
"ownership_percentage_share": null,
"policy_note_number": null,
"insurance_company_name": null,
"insurance_term": null,
"coverage_amount": null,
"premium_amount": null,
"insurance_deviation_details": null,
"cersai_txn_ref_no": null,
"cersai_security_interest_id": null,
"cersai_no_of_borrowers": null,
"cersai_no_of_documents": null,
"cersai_no_of_third_parties": null,
"country_string": "string",
"region_string": null,
"state_string": "string",
"city_string": "string",
"district_string": "string",
"taluka_string": "string",
"village_string": "string",
"karat_value": null,
"gross_weight": null,
"net_weight": null,
"rf_id": null,
"collateral_product": "string",
"installer_name": null,
"installer_gstno": null,
"installer_address": null,
"installer_city": null,
"installer_state": null,
"installer_pincode": null,
"installer_district": null,
"installer_id": null,
"cost_of_asset": null,
"pv_module_model": null,
"pv_module_make": null,
"inverter_model": null,
"inverter_make": null,
"asset_type": null,
"vehicle_type": null,
"manufacturer": null,
"product": null,
"model": null,
"chasis_no": null,
"dealer_name": null,
"dealer_address": null,
"dealer_city": null,
"dealer_state": null,
"dealer_pincode": null,
"policy_cover_note_number": null,
"insurance_company": null,
"start_date_disburse_date": null,
"coverage_type": null,
"ownership_status": null,
"installer_address_json": null,
"vehicle_registration_no": null,
"engine_no": null,
"global_collateral_identifier": "string",
"property_information": null,
"land_type": "",
"land_area": 0,
"model_year": null,
"gross_total": null,
"total_discount": null,
"total_tax": null,
"total_invoice_amount": null,
"invoice_line_item": [],
"sub_registrar": "string",
"carpet_up_area_unit": null,
"built_up_area_unit": null,
"collateral_type": "string",
"collateral_subtype": null,
"repossession_status": "string",
"property_type": null,
"nature_of_property": "string",
"market_value": 0,
"property_classification": null,
"property_ownership": null,
"property_purpose": null,
"address_type": null,
"current_usage": null,
"agreement_type": null,
"sale_deed_date": null,
"ownership_dates": [],
"disbursal_date": null,
"cersai_security_interest_creation_date": null,
"collateral_document": [],
"insurance_start_date": null,
"insurance_end_date": null,
"valuation_date_of_asset": null,
"property_usage": "string",
"hypothecation_status": null,
"s_no": null,
"owner_father_name": null,
"previous_financer": null,
"dealer_payment_mode": null,
"dealer_bank_account_number": null,
"dealer_contact_number": null
}
},
"error": null
}
Internal Server Error: 500
Note: If the API is unable to retrieve data for specific fields against the relevant Loan Id, then this error will occur.
Schema
Attribute |
Type | Description | Mandatory | |
response |
String | Internal status code that denotes the status of request | Yes | |
data |
Object | Response Object for the given inputs | No | |
error | Object Data | Object | Internal error object for the given inputs | Yes |
code | integer | Internal error code for API | Yes | |
text | String | Error message for the API | No | |
detail | String | Reason / Detail for the cause of error | No |
Body
Expected messages as per Status API :
Error Code | Description |
107001 | An Exception occurred in saving data |
{
"response": false,
"data": null,
"error": {
"code": 0,
"text": "string",
"detail": "string"
}
}
Unauthorized: 401
Note: If the API is not authorized with the Token or if the authorization token has expired, this error is going to show up.
Body
{
"code": 401,
"message": "auth fail, you can retry!"
}
No Comments