Loan Action : Document Save
POST Document Save
The " Document Save" endpoint is a part of the SynoFIn API that allows users to save or create a new document in the LMS system. This endpoint enables the client application to send data that represents a document, which can be stored, updated, or created within the system, depending on the provided parameters.
URL: {{base_url}}/loan-modification/v1/service-request/savedocument/upload
Run in Postman: Document Save
Request:
Query Params:Form-Data:
Schema
Attribute | Data Type | Description |
Drop Down Keys (Fetched from Masters) |
Mandatory | ||||||||||||||||||||||||||||||||||||||||
String | This Define the type action that needs to be performed in this case the key is "add_new". | - | Yes | |||||||||||||||||||||||||||||||||||||||||
This is the Identification type for loan documents and customer documents. |
IdType Key
|
Yes | ||||||||||||||||||||||||||||||||||||||||||
serviceRequestType | String |
This is the Unique |
- | No | ||||||||||||||||||||||||||||||||||||||||
customerOrLoanId | String |
|
- | Yes | ||||||||||||||||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||||||||||||||||||
String | This is a type of Document list that contains the list of documents (like, Aadhar, PAN, |
document_type_key
|
||||||||||||||||||||||||||||||||||||||||||
String | Unique |
|
document_status_key
Document Status |
received |
pending |
waiver |
otc |
In Whichorder theto add document isfrom receivedURL (like
Postto /pass Pre"url" Disbursal).
document_disbursal_stagedocument_format_key
url |
Uniquethe Identificationcase Number
-
document_department
Body
{requestFor:add_new
"service_request_type":idType:loan
"add_new",serviceRequestType:2
"service_request_subtype":customerOrLoanId:0
"2",documentType:salary_slip
//FordocumentState:photocopy
UploaddocumentValue:BR3900000
givedocumentStatus:received
asreceivingDate:2021-08-17
"2"documentUrl:
by default
"service_type": "",
"loan_id": "0",
"request_data": {
"document_type": "String",
"customers": 0,
"document_value": "string",
"document_type_others": "string",
"document_state": "string",
"documents_disbursal_stage": "string",
"document_status": "string",
"document_department": "string",
"transaction_date": "2023-06-19",
"upload_file": "path"
},
"service_request_id": "" //For System Use (Unique Identifier generated Once the request is initiated
}documentFormat:url
Response:
Success: 200 OK
Schema
Attribute |
Type | Description |
Mandatory | |||
response |
String | Internal status code that denotes the status of the request |
Yes | |||
data |
String | result |
Yes | |||
String | status | Yes | ||||
String |
service_request_id |
|||||
String |
unique_transaction_number |
|||||
error |
Object | Internal error object for the given inputs |
Yes |
Body
{
"response": true,
"data": {
"result": "string",
"status": "string",
"service_request_id": 0,
"unique_transaction_number": "string"
},
"error": null
}
Internal System Error: 200 OK
Note : This Error mainly occurs if the user fails to attach the file to upload or customer Id doesn't exist for the specified Loan ID.
Schema
Attribute |
Type | Description |
Mandatory | |||
response |
String | Internal status code that denotes the status of request |
Yes | |||
data |
Object | Success Response Object |
Yes | |||
String |
unique_transaction_number |
Yes | ||||
error |
Obejct | Internal error object for the given inputs |
Yes | |||
integer |
code
|
Yes | ||||
String | text | Yes |
Body
{
"response": false,
"data": {
"unique_transaction_number": null
},
"error": {
"code": 1015000,
"text": "Document add"
}
}
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!"
}