Request Consent Using Consent Template
post
{BASE_URL}/client/consent/request
REQUEST
QUERY-STRING PARAMETERS
aa_id
string
To override the AA entity ID set in the template.
REQUEST BODY
application/json
EXAMPLE
SCHEMA
{
"customer_details": {
"customer_name": "",
"customer_email": "",
"customer_ref_id": "",
"customer_mobile": "",
"customer_identifier": ""
},
"template_id": "",
"consent_details": {
"consent_start_date": "2023-02-13 00:00:00",
"consent_expiry_date": "2023-02-13 00:00:00",
"fi_start_date": "2023-02-13 00:00:00",
"fi_end_date": "2023-02-13 00:00:00",
"meta": {
"fip_ids": [
"DIGIO_FIP"
],
"email_id": "helper@email.com",
"pan": "ALKWS8927U",
"dob": "1990-01-01",
"show_consent_info": true
}
},
"customer_notification_mode":"SMS",
"notify_customer":true,
"fi_schedule": {
//Users can pass either of “weekly_frequency_meta”, “monthly_frequency_meta” or “daily frequency meta”, if all three are given, later will be given preference.
"daily_frequency_meta": {
"fi_request_time": "12:23:34",
"fetch_on_week_days_only": true //No fetch on Saturday,Sunday
},
"weekly_frequency_meta": {
"fi_request_time": "12:23:34",
"days_of_week": [
1,
2,
3,
4,
5,
6,
7
]
},
"monthly_frequency_meta": {
"fi_request_time": "12:23:34",
"dates_of_month": [
1,
2,
3,
4,
5,
6,
7
]
}
}
}
-
customerDetails *
object
An object containing the personal information of the customer associated with the consent request.
customerName
*
string
➔ The full name of the customer.
Constraints: 0 to 200 chars
customerEmail
string
The email address of the customer, used for communication and notifications.
customerRefId
string
➔ A unique reference ID for the customer, used for internal tracking purposes
Constraints: 0 to 64 chars
customerMobile
*
string
The mobile phone number of the customer, which may be used for verification or notifications.
customerIdentifier
*
string
A unique identifier for the customer
customerId
*
string
Unique customer identifier
templateId
*
string
Id of the consent template(created through FIU User portal) from which consent request is to be derived
-
consentDetails *
object
An object containing important information related to the consent request.
consentStartDate
*
date-time
The date and time when the consent becomes effective, formatted as "YYYY-MM-DD HH:MM
consentExpiryDate
*
date-time
The date and time when the consent will expire, formatted as "YYYY-MM-DD HH:MM
fiStartDate
*
date-time
The start date for the financial information retrieval period, formatted as "YYYY-MM-DD HH:MM
fiEndDate
*
date-time
The end date for the financial information retrieval period, formatted as "YYYY-MM-DD HH:MM
fipIds
[string]
List of FIP (Financial Information Provider) IDs
pan
string
PAN (Permanent Account Number) of the user
dob
string
Date of birth of the user in YYYY-MM-DD format
showConsentInfo
boolean
➔ Flag to indicate if consent info should be shown
Default: false
scheduleFiRequest
boolean
➔ Flag to indicate if FI request should be scheduled
Default: false
-
scheduleFiRequestMeta
object
This object is used to create a FI Schedule to create automatic FI requests to AA against a consent request
-
dailyFrequencyMeta
object
Meta for defining daily fetch schedule
fetchOnWeekDaysOnly
boolean
-
weeklyFrequencyMeta
object
Meta for defining weekly fetch schedule
-
monthlyFrequencyMeta
object
Meta for defining monthly fetch schedule
-
yearlyFrequencyMeta
object
Meta for defining yearly fetch schedule
-
fiSchedule
object
This object is used to create a FI Schedule to create automatic FI requests to AA against a consent request
-
dailyFrequencyMeta
object
Meta for defining daily fetch schedule
fetchOnWeekDaysOnly
boolean
-
weeklyFrequencyMeta
object
Meta for defining weekly fetch schedule
-
monthlyFrequencyMeta
object
Meta for defining monthly fetch schedule
-
yearlyFrequencyMeta
object
Meta for defining yearly fetch schedule
customerNotificationMode
enum
➔ SMS/WHATSAPP
Allowed: SMS┃WHATSAPP
notifyCustomer
boolean
Notify customer over SMS/WHATSAPP from where user can initiate journey through a link
API Server
https://api.digio.in/fiu_api
Authentication
Not Required
FILL EXAMPLE
CLEAR
TRY
Copy
curl -X POST "https://api.digio.in/fiu_api/client/consent/request" \
-H 'accept: application/json'
RESPONSE
200
consentRequestId
*
string
A unique identifier for the consent request, which is used to track and reference the specific request
-
customerDetails *
object
An object containing the personal information of the customer associated with the consent request.
customerName
*
string
➔ The full name of the customer.
Constraints: 0 to 200 chars
customerEmail
string
The email address of the customer, used for communication and notifications.
customerRefId
string
➔ A unique reference ID for the customer, used for internal tracking purposes
Constraints: 0 to 64 chars
customerMobile
*
string
The mobile phone number of the customer, which may be used for verification or notifications.
customerIdentifier
*
string
A unique identifier for the customer
status
enum
➔ The current status of the consent request (e.g., "PENDING"). This indicates whether the request is still awaiting action or has been completed.
Allowed: PENDING┃REQUESTED┃APPROVED┃ACTIVE┃PAUSED┃REJECTED┃REVOKED┃REQUEST_EXPIRED┃EXPIRED┃FAILED┃QUEUED_FOR_RETRY
-
consentDetails
object
An object containing important information related to the consent request.
consentStartDate
*
date-time
The date and time when the consent becomes effective, formatted as "YYYY-MM-DD HH:MM
consentExpiryDate
*
date-time
The date and time when the consent will expire, formatted as "YYYY-MM-DD HH:MM
fiStartDate
*
date-time
The start date for the financial information retrieval period, formatted as "YYYY-MM-DD HH:MM
fiEndDate
*
date-time
The end date for the financial information retrieval period, formatted as "YYYY-MM-DD HH:MM
fipIds
[string]
List of FIP (Financial Information Provider) IDs
pan
string
PAN (Permanent Account Number) of the user
dob
string
Date of birth of the user in YYYY-MM-DD format
showConsentInfo
boolean
➔ Flag to indicate if consent info should be shown
Default: false
scheduleFiRequest
boolean
➔ Flag to indicate if FI request should be scheduled
Default: false
-
scheduleFiRequestMeta
object
This object is used to create a FI Schedule to create automatic FI requests to AA against a consent request
-
dailyFrequencyMeta
object
Meta for defining daily fetch schedule
fetchOnWeekDaysOnly
boolean
-
weeklyFrequencyMeta
object
Meta for defining weekly fetch schedule
-
monthlyFrequencyMeta
object
Meta for defining monthly fetch schedule
-
yearlyFrequencyMeta
object
Meta for defining yearly fetch schedule
dataFrequencyValue
integer
The value representing how often data is fetched
dataFrequencyUnit
enum
➔ The unit of time for data frequency, such as DAY, WEEK, or MONTH
Allowed: HOUR┃DAY┃MONTH┃YEAR┃INF
createdAt
date-time
Timestamp of when the consent was created
consentExpireDate
date-time
Timestamp when the consent is set to expire
requestExpireDate
date-time
Timestamp when the data request will expire
templateName
string
Name of the template used for the consent
templateId
string
Unique identifier for the template
aaId
string
Account Aggregator ID through which the consent is routed
-
fiSchedule
object
This object is used to create a FI Schedule to create automatic FI requests to AA against a consent request
-
dailyFrequencyMeta
object
Meta for defining daily fetch schedule
fetchOnWeekDaysOnly
boolean
-
weeklyFrequencyMeta
object
Meta for defining weekly fetch schedule
-
monthlyFrequencyMeta
object
Meta for defining monthly fetch schedule
-
yearlyFrequencyMeta
object
Meta for defining yearly fetch schedule
requireAnalytics
boolean
➔ Indicates whether analytics are required as part of the consent
Default: false
allowDataFileUpload
boolean
➔ Indicates whether data file upload is allowed for the consent
Default: false