Consent Handle Request
Create consent handle with Account Aggregator | This API is used to request the lenders to send a consent request for fetching the bank account statements, GST, historical data.
The lender (FIU) checks with the AA and creates a consent handle internally once this API is triggered
Request Body Request by LA to lender to get consent handle with Account Aggregator |
---|
metadata object — REQUIREDMetadata specific to each API request. version string — REQUIRED | originatorOrgId stringThe organisation id on the Participant Registry. | originatorParticipantId stringThe 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 — REQUIREDUUID used to tie request and response and for idempotency |
|
productData object — REQUIREDProduct Metadata specific to each API request. productId string — REQUIREDThe product id on the Product Registry. | productNetworkId stringThe product network id on the Product Registry. |
|
loanApplicationIds string[] — REQUIRED |
consent object — REQUIREDconsentFetchType stringPossible values: [ONETIME , PERIODIC ] | vua string | description string | isAggregationEnabled boolean | consentAggregationId string | consentHandle string | consentStatus stringPossible values: [READY , PENDING , FAILED ] | url string | extensibleData objectThis API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. |
|
Responses |
---|
200
Acknowledgement by Lender to BA for Consent Handle Request Schema — OPTIONAL |
---|
error string | traceId string | timestamp string |
|