Digio Apis

Getting started with Digio Rest Apis

API SERVER

SELECTED: https://api.digio.in/fiu_api
AUTHENTICATION
No API key applied
General ⦂

Retrieving Status and Details of Consent Requests

get {BASE_URL}/client/consent/request/{consent_request_id}/details
REQUEST
PATH PARAMETERS
API Server
https://api.digio.in/fiu_api
Authentication
Not Required 
curl -X GET "https://api.digio.in/fiu_api/client/consent/request/{consent_request_id}/details" \
 -H 'accept: application/json'
RESPONSE
200
application/json
object
Single line description
Field
Type
Description
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.

id
string
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
panNumber
string
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
- meta
object

Consent Meta

fipIds
[string]

List of FIP (Financial Information Provider) IDs
⮕ [ List of FIP (Financial Information Provider) IDs ]

emailId
string

Email ID of the user
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

fiRequestTime
date-time
fetchOnWeekDaysOnly
boolean
- weeklyFrequencyMeta
object

Meta for defining weekly fetch schedule

fiRequestTime
date-time
daysOfWeek
[integer]
- monthlyFrequencyMeta
object

Meta for defining monthly fetch schedule

fiRequestTime
date-time
datesOfMonth
[integer]
- yearlyFrequencyMeta
object

Meta for defining yearly fetch schedule

fiRequestTime
date-time
datesOfYear
[string]
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

fiRequestTime
date-time
fetchOnWeekDaysOnly
boolean
- weeklyFrequencyMeta
object

Meta for defining weekly fetch schedule

fiRequestTime
date-time
daysOfWeek
[integer]
- monthlyFrequencyMeta
object

Meta for defining monthly fetch schedule

fiRequestTime
date-time
datesOfMonth
[integer]
- yearlyFrequencyMeta
object

Meta for defining yearly fetch schedule

fiRequestTime
date-time
datesOfYear
[string]
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