Skip to main content

Send Additional Documents Request

This API is invoked by the LA informing the lender regarding the additional documents that are required to be submitted by the borrower for a particular loan application with the Action Required status in the Generate Offers Response API.

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.

loanApplications object[]
loanApplicationId string REQUIRED

UUID for the loan application.

additionalDocuments object[]
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