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

Consent Handle Request

This API is invoked by the LSP to request that the lenders send a consent request for fetching the bank account statements, GST historical data. The lender (FIU) checks with the AA, and then the AA creates a consent handle internally once this API is triggered.

Response Parameters for the Consent Handle 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, and an object with Consent information.     (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 Consent Handle 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 borrower wants consents to be created.
consent:  {params, object}ObjectThis includes the consent details needed for the loan
  Parameters for the consent object:   (click to open)
vuaStringCustomer unique identifier created by the AA.
Example: "[email protected]"
descriptionStringDescription of the consent
lspInfo:wwwwwwwwww
   {param1, param2, ...}
ObjectThis information is supposed to be passed to AA so that they can write custom logic for handling the consent
  Parameters for the lspInfp object:    (click to open)
lspIdStringAA can identify the LSP based on this
versionStringversion of LSP
appNameStringPackage name of the app
consentFetchTypewwiwwStringPeriodicity for the consent data fetch
Example: "ONETIME"
isAggregationEnabledBooleanFlag indicating whether the consents need to be aggregated
consentAggregationIdStringThis is an id generated by LSP which is passed on to AA to tell the AA how to aggregate all the consent requests from all the lenders.
consentHandleStringConsent handles created by the AA when requested by the lender. This field will be filled when status is PENDING
consentStatusStringStatus of the consent
urlStringFor any new data that needs to be passed as a link
extensibleDatawwwiwwJSONFor any new data that needs to be added.
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!