Skip to main content

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 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

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.

loanApplicationIds string[] REQUIRED
consent object REQUIRED
consentFetchType string

Possible values: [ONETIME, PERIODIC]

vua string
description string
isAggregationEnabled boolean
consentAggregationId string
consentHandle string
consentStatus string

Possible values: [READY, PENDING, FAILED]

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 by Lender to BA for Consent Handle Request

Schema OPTIONAL
error string
traceId string
timestamp string