Skip to main content

Loan agreement Request

Request for the Loan agreement sent by the LA to the lender and initiates the process for the borrower to receive the Loan agreement and accept the terms via OTP.

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
baRedirectURL string

URL to which the borrower will be redirected after completing the Loan Agreement Signing process from the Lenders e-sign Page.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string