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 against Loan Id, Loan Application Number (lan) or Customer Id 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-management/v1/document/upload

Request:

Request Type: POST

Authorization: Bearer Token

Form-Data:

Schema

Attribute

Data Type

Description

Drop Down Keys

(Fetched from Masters)

Mandatory

requestFor

String

This Define the type action that needs to be performed in this case the key is "documents".

Yes

idType

String

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

IdType Key

IdType Key

loan

customer

lan

Yes

serviceRequestType

String

This is the Unique Identification for the Service Request type for the Document upload is "2".

customerOrLoanId

String

Unique Identifier for the specified "idType"

Yes

documentType

String

This is a type of Document list that contains the list of documents (like, Aadhar, PAN, etc. ).

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

Yes

documentValue

String

Unique Identification Number of the ID

documentStatus

String

This is the Status of the Document that is submitted (Like Pending, Received).

document_status_key

Document Status

received

pending

waiver

otc

Yes

documentFormat

String

In order to add document through URL, you need to pass "url"

document_format_key

document_format

url

localfile

documentUrl

String

For the case of URL pass the URL inside this param

receivingDate

Date

Date of receiving document (format : yyyy-MM-dd)

documentFile

(Binary)

In case file is passed instead of the URL

Body

requestFor:add_new
idType:loan
serviceRequestType:2
customerOrLoanId:0
documentType:salary_slip
documentState:photocopy
documentValue:BR3900000
documentStatus:received
receivingDate:2021-08-17
documentUrl:
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

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