Financial Information Request Creation
post
{BASE_URL}/client/fi/request/{consent_request_id}
REQUEST
PATH PARAMETERS
*
consent_request_id
string
Id of the consent_request which is being monitored
REQUEST BODY
application/json
EXAMPLE
SCHEMA
{
"from": "2023-01-30 00:00:00",
"to": "2024-04-04 00:00:00"
}
from
date-time
Starting date and time of the range. Format: YYYY-MM-DD HH:MM:SS
to
date-time
Ending date and time of the range.Format: YYYY-MM-DD HH:MM:SS
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/fi/request/{consent_request_id}" \
-H 'accept: application/json'
RESPONSE
200
fiRequestId
string
A unique identifier for the Financial Information request. This ID is used to track and reference the specific request within the system
fiStartDate
date-time
The starting date and time from which financial information is requested, formatted as "YYYY-MM-DD HH:MM
. This indicates when the retrieval of data should begin.
fiEndDate
date-time
The ending date and time for the financial information retrieval, also formatted as "YYYY-MM-DD HH:MM
This marks the endpoint for the requested data period.
status
enum
➔ Current status of the FI request
REQUESTED: FI Request is initiated but not yet processed or completed.
DATA_AVAILABLE: Data is ready to be fetched.
FAILED: Error occurred during FI request stage.
EXPIRED: FI Request is expired.
Allowed: REQUESTED┃DATA_AVAILABLE┃PARTIAL┃FAILED┃PURGED┃EXPIRED┃REQUEST_EXPIRED┃ANALYSIS_DONE
-
accounts
array of object
Accounts information for the given fi request
accountId
string
Account unique identifier generated by Digio
linkRefNumber
string
Reference Number assigned by FIP as part of account linking process.
maskedAccountNumber
string
Masked account number as received from FIP.
fiType
enum
➔ Type of data associated with the account.
Allowed Values
AIF, BONDS, CD, CIS, CP, CREDIT_CARD, DEBENTURES, DEPOSIT, EPF, EQUITIES, ETF, GOVT_SECURITIES, IDR, INVIT, INSURANCE_POLICIES, MUTUAL_FUNDS, NPS, PPF, REIT, RECURRING_DEPOSIT, SIP, TERM_DEPOSIT, GENERAL_INSURANCE, LIFE_INSURANCE, ULIP, GST, GSTR
Allowed: AIF┃BONDS┃CD┃CIS┃CP┃CREDIT_CARD┃DEBENTURES┃DEPOSIT┃EPF┃EQUITIES┃ETF┃GOVT_SECURITIES┃IDR┃INVIT┃INSURANCE_POLICIES┃MUTUAL_FUNDS┃MUTUALFUNDS┃NPS┃PPF┃REIT┃RECURRING_DEPOSIT┃SIP┃TERM_DEPOSIT┃GENERAL_INSURANCE┃LIFE_INSURANCE┃ULIP┃GST┃GSTR┃GST_GSTR1┃GST_GSTR2A┃GST_GSTR3B┃GSTR1_3B┃OTHER
fipId
string
Entity Id of the FIP as registered in SAHAMATI
-
fi
array of object
Financial information
-
fiData
object
Stringified json of the decrypted FI Data in raw format as received from FIP
-
[any-key]
object
Stringified json of the decrypted FI Data in raw format as received from FIP
fipId
string
Id of FIP from which current object of FI is fetched
fiType
enum
➔ Type of data associated with the account.
Allowed Values
AIF, BONDS, CD, CIS, CP, CREDIT_CARD, DEBENTURES, DEPOSIT, EPF, EQUITIES, ETF, GOVT_SECURITIES, IDR, INVIT, INSURANCE_POLICIES, MUTUAL_FUNDS, NPS, PPF, REIT, RECURRING_DEPOSIT, SIP, TERM_DEPOSIT, GENERAL_INSURANCE, LIFE_INSURANCE, ULIP, GST, GSTR
Allowed: AIF┃BONDS┃CD┃CIS┃CP┃CREDIT_CARD┃DEBENTURES┃DEPOSIT┃EPF┃EQUITIES┃ETF┃GOVT_SECURITIES┃IDR┃INVIT┃INSURANCE_POLICIES┃MUTUAL_FUNDS┃MUTUALFUNDS┃NPS┃PPF┃REIT┃RECURRING_DEPOSIT┃SIP┃TERM_DEPOSIT┃GENERAL_INSURANCE┃LIFE_INSURANCE┃ULIP┃GST┃GSTR┃GST_GSTR1┃GST_GSTR2A┃GST_GSTR3B┃GSTR1_3B┃OTHER
accountAnalyticsAvailable
boolean
True :Json Analytics data available
accountSubAnalyticsAvailable
boolean
True :File Analytics data available
accountId
string
Digio internal identifier for individual customer account
fiDataId
string
Digio internal identifier for data fetch wrt individual FIP
consentRequestId
string
A unique identifier for the associated consent request. This ID is necessary to validate that the request has the appropriate permissions and authorizations