Skip to main content

Get Additional Pledged Documents Request

This API will be invoked by the Lender to pull any additional documents available. The hasAdditionalDocuments flag in the pledgedDocuments object of the loan application will be set to true if there are any additional documents available.

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.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string