Skip to main content

List of Documents

List of Documents

The List of Documents API is used to get all the documents that users supplied during loan creation and to build a Lod letter that certifies that the papers were received. The user add multiple document at once has to define the Form / Type they received the Documents.

Screenshot 2023-04-20 at 4.24.28 PM.png

This Is performed in two steps that are :

1. Fetch List Of Document Received for Loan Id
2. Download List Of Document Letter


Fetch List Of Document Details

GET Lod by Loan Id

This API enables the user to retrieve the List of Document for the Loan Id if already present or the user also has right to either Remove or ADD documents for the specified Loan Id using this API.

URL: {{base_url}}/loan-management/v1/getLodByLoanId

Request 
Request Type: GET
Authorization: Bearer Token
Query Parameter
Key Data Type Value
loanId* integer -
*required parameter
Response: 200


{
   "response": true,
   "data": [
      {
         "id": 0,
         "loanId": 0,
         "clientName": "string",
         "documentName": "string",
         "documentType": "string",
         "documentDescription": "string",
         "documentDate": "timestampz",
         "deleted": false,
         "active": true,
         "transactionId": null
      }
   ],
   "error": null
}

POST Master Data for List of Documents

To obtain Master data for List of Documents, utilise this API.

URL: {{base_url}}/loan-management/v1/getMasterType

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Request Body * required Param


[
  {
   "type": "document_state"
  },
  {
   "type": "document_type"
  }
]

Response: 200

{
   "response": true,
   "data": [
      {
         "document_state": {},
         "document_type": {}
      }
   ],
   "error": null
}

 

Download List Of Document Letter

GET List of Document

This API enables the user to retrieve the List of Document for the Loan Id.

URL: {{base_url}}/loan-management/v1/getLodPdf

Request 
Request Type: GET
Authorization: Bearer Token
Query Parameter :  No Parameter
Request Body*required parameter


{
   "loan_id": 0,
   "document_data": []
}

Response: 200
{}
No Comments
Back to top