Skip to main content

Loan agreement Response

Response from the Lender to the LA sharing the loan agreement request for the borrower.

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

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
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
loanApplicationStatus string REQUIRED

Possible values: [CREATED, PROCESSING, CONSENT_INITIATED, CONSENT_RECEIVED, CONSENT_REJECTED, OFFERED, OFFER_ACCEPTED, KYC_INITIATED, KYC_COMPLETED, KYC_FAILED, KYC_REJECTED, LOAN_AGREEMENT_INITIATED, LOAN_AGREEMENT_COMPLETED, LOAN_AGREEMENT_FAILED, REPAYMENT_SETUP_INITIATED, REPAYMENT_SETUP_COMPLETED, REPAYMENT_SETUP_FAILED, REPAYMENT_SETUP_REJECTED, SET_DISBURSEMENT_ACCOUNT_INITIATED, SET_DISBURSEMENT_ACCOUNT_COMPLETED, SET_DISBURSEMENT_ACCOUNT_FAILED, SET_DISBURSEMENT_ACCOUNT_REJECTED, GRANTED, REJECTED, ACTION_REQUIRED, DISBURSEMENT_INITIATED, DISBURSEMENT_COMPLETED, DISBURSED_FAILED, CLOSED, CANCELLED]

loanAgreement object REQUIRED
legalDocument object
type string REQUIRED

Possible values: [TEXT, DOCUMENT_URL, REDIRECT_TO_LENDER_URL]

data string REQUIRED
status string

Possible values: [AGREEMENT_READY, ACTION_REQUIRED]

actionRequired object[]
actionType string REQUIRED

Possible values: [ADD_DOCUMENT, RESUBMIT_DOCUMENT, ADDITIONAL_DATA, OTHER]

description string REQUIRED
reference object REQUIRED
object string REQUIRED
value string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string