Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Generate Offers Request

Once the consents needed for fetching data are ready, the LSP sends a request to the Lenders to generate the offer for a set of loan applications. All these loan applications belong to the same borrower. This API is the trigger point for the lenders to use the consentIds that were created for the loanapplicationids as part of the Consent APIs to fetch the data from various FIPs as needed for the loan use case. Once the data from these sources have been obtained, the lender system runs its business rules on the data and creates the offers

Response Parameters for the Generate Offers Request API:
(click to view)
ParameterTypeDescription
ack:wwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
The request for this API includes an array for Loan Application IDs     (click to open tables)
ParameterTypeDescription
metadata:wwwwtwwwww
 {param1, param2,...}
Object
Strings
Metadata specific to each API response
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestIdwwwwwwwtwwwStringUnique reference ID for the Generate Offers Request (UUID used to tie request and response and for idempotency)
loanApplicationIds:  [....]Array of
Strings
UUID for the loan applications. Generated by LSP. These are the list of loan Applications for which the borrower wants offers
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!