post https://api.juspay.in/v3/consent/consentHandleRequest
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)
(click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwww {error, traceId, timestamp} | Object | JSON object for acknowlegement |
Parameters for the
ack object: | Parameter | Type | Description |
|---|---|---|
| error | String | Errors in the current request received. If no errors are found, error = 0. |
| traceId | String | Identification for tracing |
| timestamp | Time- 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)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwwwtwwwww {param1, param2,...} | Object Strings | Metadata specific to each API response |
Parameters for the metadata object: click to open)
| Field | Type | Description | |
|---|---|---|---|
| version | String | OCEN Version | |
| timestamp | Time- 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) | |
| traceId | String | Identification for tracing | |
| orgId | String | Origin ID |
| requestIdwwwwwwwtwww | String | Unique 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} | Object | This includes the consent details needed for the loan |
Parameters for the consent object: (click to open)
| vua | String | Customer unique identifier created by the AA. Example: "[email protected]" | |
| description | String | Description of the consent | |
| lspInfo:wwwwwwwwww {param1, param2, ...} | Object | This 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)
| lspId | String | AA can identify the LSP based on this | |
| version | String | version of LSP | |
| appName | String | Package name of the app |
| consentFetchTypewwiww | String | Periodicity for the consent data fetch Example: "ONETIME" | |
| isAggregationEnabled | Boolean | Flag indicating whether the consents need to be aggregated | |
| consentAggregationId | String | This 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. | |
| consentHandle | String | Consent handles created by the AA when requested by the lender. This field will be filled when status is PENDING | |
| consentStatus | String | Status of the consent | |
| url | String | For any new data that needs to be passed as a link | |
| extensibleDatawwwiww | JSON | For any new data that needs to be added. |
* = Required