Skip to main content

Get Additional Pledged Documents Response

This API will be invoked by the Loan Agent to push additional documents available againgst the loan application in a paginated manner as requested by the Lender.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

loanApplicationId string REQUIRED

UUID for the loan application.

requestedDocumentPagination object
pageNumber integer

Page number to be fetched.

pageSize integer

Number of documents to be fetched per page.

totalDocumentCount integer

Total number of documents available.

pledgedDocuments object
totalDocumentCount integer REQUIRED
hasAdditionalDocuments boolean REQUIRED
documents object[] REQUIRED
id string
source string REQUIRED

Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER]

sourceIdentifier string REQUIRED
format string REQUIRED

Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL]

reference string REQUIRED
type string REQUIRED

Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER]

isDataInline boolean REQUIRED
data string REQUIRED
Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string