Skip to main content

Loan Action : Document Save

POST Document Save

The " Document Save" endpoint is a part of the SynoFIn API that allows clients 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/save

Run in Postman: Document Save

Request: 

Request Type: POST
Authorization: Bearer Token
Query Params:
Schema
Attribute Data Type Description Mandatory
service_request_type String This Define the type action that needs to be performed in this case the key is "add_new". Yes
loan_id Number

This is the Unique Loan Identification Number against which the Document should be saved.

 Yes
customers Number

This is the Unique Customer Identification Number against which the Document should be saved.

 Yes
document_type String This is type of Document list that contains the list of documents (like, Aadhar, PAN, etc ). Yes
document_state String This is how or in which form the Document is submitted by the client (like Certificate, Original, Photocopy, etc). Yes
document_status String This is the Status of the Document that is submitted (Like Pending, Received). Yes
documents_disbursal_stage String

In Which the document is received (like

Post / Pre Disbursal).

 Yes
document_value String

Unique Identification Number

 Yes
document_department String This is where the document belongs to is set (like Legal, Credit, Audit).  Yes
upload_file String In this the file needs to be is given Yes
Body 
{
    "service_request_type": "add_new",
    "service_request_subtype": "2", //For Upload give as "2" 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 
}


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!"
}

Back to top