Skip to main content

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: 

Request Type: POST
Authorization: Bearer Token
Query Params:Form-Data:
Schema
Attribute Data Type Description

Drop Down Keys

(Fetched from Masters)

Mandatory
service_request_typerequestFor String This Define the type action that needs to be performed in this case the key is "add_new". - Yes
loan_ididType NumberString

This is the Identification type for loan documents and customer documents.

IdType Key
IdType Key
loan
customer
Yes
serviceRequestTypeString

This is the Unique Loan Identification Numberfor againstthe whichService Request type for the Document shouldupload beis saved.is "2".

-No
customerOrLoanIdString

-Unique Identifier for the specified "idType" 

- Yes
customersNumber

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

-

Yes
document_typedocumentType String This is a type of Document list that contains the list of documents (like, Aadhar, PAN, etcetc. ).
document_type_key
Document Type
current_address_proof
regulatory_check
p_mandate_nach
aadhaar_front
salary_slip
salarySlip
bussiness_stock
selfie_infornt_of_bussiness_setup
business_stock
profile_photo
esigned_sanction_letter
papaer_mandate
bussiness_board
udyam_aadhaar
aadhaar_photo
pan
reference
selfie_infront_of_business_setup
aadhaar_back
faceMatch
business_board
aadhaar_document
bank_statement_pdf
bank_statement_excel
sanction_letter
agreement_letter
cam_sheet
video_kyc_selfie
hypothecation_letter
income_assessment
ownership_proof
residence_fi
business_fi
cibil
add_bank_statement
dedupe
udhyam_certificate
approval_mail
tvr


NoYes
document_statedocumentValue String This is

Unique howIdentification orNumber in which formof the DocumentID

is submitted by the client (like Certificate, Original, Photocopy, etc).
document_state_key

-

Document State
photocopy
original
certificate
notarized
original_laminated
original_punched
No
document_statusdocumentStatus String This is the Status of the Document that is submitted (Like Pending, Received).
document_status_key
Document Status
received
pending
waiver
otc
NoYes
documents_disbursal_stagedocumentFormat String

In Whichorder theto add document isfrom receivedURL (like

need

Postto /pass Pre"url" Disbursal).

Key
document_disbursal_stagedocument_format_key
Documents Disbursal Stagedocument_format
pre_disbursal
url
post_disbursallocalfile
No
document_valuedocumentUrl String For

Uniquethe Identificationcase Number

of URL pass the URL inside this param

-

No
document_departmentreceivingDate StringDate ThisDate isof where thereceiving document belongs(format to: is set (like Legal, Credit, Audit). yyyy-MM-dd)
document_department
Document Department
legal
credit
operation
audit
-
No
upload_filedocumentFile String(Binary) URLIn oforder to upload document from the local file we add using this columnt - YesNo
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!"
}