Skip to main content
POST
/
getallfidataPdf
Get All FI Data PDF
curl --request POST \
  --url https://api.example.com/getallfidataPdf \
  --header 'appIdentifier: <appidentifier>' \
  --header 'client_id: <client_id>' \
  --header 'client_secret: <client_secret>' \
  --header 'content-Type: <content-type>' \
  --header 'organisationId: <organisationid>' \
  --data '
{
  "consentID": "<string>",
  "linkRefNumber": [
    {}
  ],
  "transactionsStartDate": "<string>",
  "transactionsEndDate": "<string>"
}
'

​
Overview

The Get All FI Data PDF API allows you to download complete financial information in PDF format for accounts associated with a specific consent. This API is ideal when you need human-readable, formatted financial statements that can be easily viewed, printed, or shared with end users. The PDF includes formatted account details, transaction history, balance information, and account holder details in a professional document layout.

​
Key Use Cases

  • User-Facing Reports: Generate formatted financial statements that users can easily read and understand.
  • Document Archival: Create permanent records of financial data in a standardized PDF format.
  • Regulatory Compliance: Provide formatted financial documents for compliance and audit purposes.
  • Selective Account Retrieval: Download PDFs for specific accounts by providing their link reference numbers.
  • Transaction Filtering: Generate PDFs containing only transactions within a specified date range.

​
Important Notes

  • Data will only be returned if it is available in FinPro. Ensure the FI Request has been completed and the status shows DATA_READY before calling this API.
  • The requested data must align with the parameters specified in the approved consent.
  • If you need data in structured JSON format for programmatic processing, use the Get All FI Data API instead.
  • The response is a binary PDF file, not JSON. Handle the response accordingly in your application.

​
Authentication

This API requires authentication using the following headers:
​
client_id
string
required
Your unique client identifier provided by FinPro during onboarding. This ID is used to authenticate your application.
​
client_secret
string
required
Your confidential client secret key provided by FinPro. This must be kept secure and never exposed in client-side code.
​
appIdentifier
string
required
The unique identifier for your application (e.g., your application’s package name or bundle ID). This helps FinPro identify which application is making the request.
​
organisationId
string
required
Your organization’s unique identifier assigned by FinPro. This identifies your organization in the FinPro system.
​
content-Type
string
required
Must be set to application/json to indicate that the request body contains JSON data. Note that the response will be a PDF file (binary content).

​
Request Body

​
consentID
string
required
The unique consent identifier provided by the Account Aggregator after consent approval. This must be a valid GUID format identifier.
​
linkRefNumber
array
An array of link reference numbers for specific accounts for which PDF data is required. If this parameter is not provided, PDFs will be generated for all accounts linked to the consent. Use this to generate PDFs for selected accounts only.
​
transactionsStartDate
string
The start date from when transaction data should be included in the PDF. Must be in ISO 8601 UTC date-time format (e.g., 2023-01-01T00:00:00Z). When provided, only transactions on or after this date will be included.
​
transactionsEndDate
string
The end date until when transaction data should be included in the PDF. Must be in ISO 8601 UTC date-time format (e.g., 2023-01-31T23:59:59Z). When provided, only transactions on or before this date will be included.

​
Request Example - All Accounts

{
  "consentID": "15c8007e-3435-4a81-8730-b67690a1c9a6"
}

​
Request Example - Specific Accounts

{
  "consentID": "15c8007e-3435-4a81-8730-b67690a1c9a6",
  "linkRefNumber": [
    "7cd06b51-9e73-4600-a1e1-e97a6df659f4",
    "0d200ea3-1eb4-4418-b154-2b4836a9501e"
  ]
}

​
Request Example - With Transaction Date Filtering

{
  "consentID": "15c8007e-3435-4a81-8730-b67690a1c9a6",
  "linkRefNumber": [
    "0d200ea3-1eb4-4418-b154-2b4836a9501e"
  ],
  "transactionsStartDate": "2023-01-01T00:00:00Z",
  "transactionsEndDate": "2023-01-31T23:59:59Z"
}

​
Response Format

​
Success Response

The API returns a binary PDF file as the response body with the following characteristics:
  • Content-Type: application/pdf (the response header will indicate this)
  • Format: PDF version 1.3 or higher
  • Content: Formatted financial information including:
    • Account profile details
    • Account holder information (name, DOB, mobile, email, PAN, address)
    • Account summary (balance, account type, branch, IFSC, MICR codes)
    • Transaction history in a tabular format
    • Bank/FIP name and account details
The PDF is professionally formatted with:
  • Clear section headers for Profile, Summary, and Transactions
  • Tabular layout for transaction data
  • Masked account numbers for security
  • All relevant account holder and account details
Note: The response is binary PDF content, not JSON. Your application should handle the response as a file download.

​
PDF Content Structure

The generated PDF contains the following sections:

​
1. Header Section

  • Financial Institution Provider (FIP) name
  • FI Type (e.g., Deposit, Mutual Funds)

​
2. Profile Section

Contains account holder information organized in a table:
FieldDescription
NameAccount holder’s full name
DOBDate of birth
MobileMobile phone number
E-MailEmail address
AddressComplete residential address
PANPermanent Account Number
CKYC ComplianceKYC compliance status (YES/NO)

​
3. Summary Section

Contains account summary details:
FieldDescription
Current BalanceCurrent account balance with currency
Balance Date TimeTimestamp of balance calculation
Account TypeType of account (SAVINGS/CURRENT)
BranchBank branch name
FacilityAccount facilities (e.g., OD for overdraft)
IFSC CodeBank’s IFSC code
MICR CodeBank’s MICR code
Opening DateAccount opening date
Current OD LimitCurrent overdraft limit
Drawing LimitDrawing limit available
StatusAccount status (ACTIVE/INACTIVE)

​
4. Transactions Section

Contains transaction history in tabular format:
ColumnDescription
Transaction IdUnique transaction identifier
TypeTransaction type (CREDIT/DEBIT)
ModeTransaction mode (UPI, NEFT, RTGS, CASH, etc.)
AmountTransaction amount
Current BalanceBalance after transaction
Transaction TimestampDate and time of transaction
Value DateValue date of transaction
NarrationTransaction description/narration
ReferenceReference number (e.g., cheque number)

​
Response Field Descriptions

All fields present in the PDF are derived from the structured financial data. The table below describes the data fields and their possible values:

​
Profile Fields

FieldTypeValuesDescription
Holders TypestringSINGLE, JOINTIndicates if the account has single or multiple holders
Holder Namestring-Full name of the account holder
DOBstringDate formatDate of birth of the account holder
Mobilestring10-digit numberMobile phone number
NomineestringRegistered, Not-RegisteredNominee registration status
Landlinestring-Landline phone number if available
Addressstring-Complete residential address
EmailstringEmail formatEmail address
PANstring10-characterPermanent Account Number
CKYC CompliancestringYES, NO, NO_DATA_AVAILABLECentral KYC compliance status

​
Summary Fields

FieldTypeValuesDescription
Current BalancestringNumericCurrent account balance
CurrencystringINR, USD, etc.Currency of the balance
Exchange RatestringNumericExchange rate if applicable
Balance DateTimestringISO timestampWhen the balance was calculated
TypestringSAVINGS, CURRENTType of account
Branchstring-Bank branch name
FacilitystringOD, etc.Account facilities available
IFSC Codestring11 charactersBank’s IFSC code
MICR Codestring9 digitsBank’s MICR code
Opening DatestringDate formatDate when account was opened
Current OD LimitstringNumericCurrent overdraft limit
Drawing LimitstringNumericAvailable drawing limit
StatusstringACTIVE, INACTIVE, etc.Current account status

​
Transaction Fields

FieldTypeValuesDescription
TypestringCREDIT, DEBITTransaction direction
ModestringCASH, UPI, IMPS, NEFT, RTGS, CARD, ATM, CHEQUE, DEMAND_DRAFT, AUTO_DEBIT, INTEREST_CREDIT, NACH, ECS, REMITTANCE, OTHERSMode of transaction
AmountstringNumericTransaction amount
Current BalancestringNumericBalance after this transaction
Transaction TimestampstringISO timestampWhen the transaction occurred
Value DatestringDate formatValue date of the transaction
Transaction IDstring-Unique transaction identifier
Narrationstring-Description of the transaction
Referencestring-Reference number (e.g., cheque number)

​
Error Responses

When the provided consent ID does not exist: 
{
  "ver": "1.21.0",
  "timestamp": "2025-10-01T11:51:28.773Z",
  "errorCode": "InvalidConsentId",
  "errorMsg": "Consent ID does not exist."
}
HTTP Status Code: 400 Bad Request

​
Common Error Scenarios

When errors occur, the response will be JSON (not PDF) containing error details:
  • InvalidConsentId: The provided consent ID does not exist in the system or has been deleted.
  • InvalidRequest: The request body contains invalid data, such as malformed date formats or invalid link reference numbers.
  • NoDataAvailable: No financial data has been fetched for this consent yet. Ensure you’ve completed the FI Request and the status is DATA_READY.
  • DataIsDeleted: The data has expired and been deleted according to the data retention policy.
  • ConsentRevoked: The consent has been revoked by the user and can no longer be used.

​
Rate Limiting

This API is subject to rate limiting to ensure fair usage and system stability:
  • Rate Limit: 1000 requests per time window
  • Headers Returned:
    • X-RateLimit-Limit: Maximum number of requests allowed
    • X-RateLimit-Remaining: Number of requests remaining in current window
    • X-RateLimit-Reset: Unix timestamp when the rate limit resets
If you exceed the rate limit, you will receive a 429 Too Many Requests response.

​
Usage Flow

  1. Verify Data Readiness: Use the FI Request Status API to ensure the eventStatus is DATA_READY before calling this API.
  2. Identify Required Accounts: If you only need PDFs for specific accounts, collect their linkRefNumber values from the FI Request Status API response.
  3. Request PDF: Call this API with the consentID and optionally the linkRefNumber array to specify which accounts you want.
  4. Handle Binary Response: The response will be a binary PDF file. Save it to disk or stream it to the user as appropriate for your application.
  5. Check Response Type: If the response is JSON instead of PDF, it indicates an error. Parse the JSON to understand the error.
  6. Present to User: Display, download, or share the PDF with the end user as needed.

​
Best Practices

  • Status Check First: Always verify that data is ready using the FI Request Status API before attempting to retrieve the PDF. Calling this API when data is not ready will result in an error.
  • Selective Downloads: If you only need data for specific accounts, use the linkRefNumber parameter to request only those accounts. This reduces response size and processing time.
  • Transaction Filtering: Use transactionsStartDate and transactionsEndDate to generate PDFs with only relevant transactions. This is especially useful for monthly or quarterly statements.
  • Error Handling: Check the response Content-Type header. If it’s application/json, parse it as an error response. If it’s application/pdf, handle it as a binary file.
  • File Naming: When saving the PDF, use a meaningful filename that includes the consent ID, account details, and date range for easy identification (e.g., FI_Data_ConsentID_StartDate_EndDate.pdf).
  • User Presentation: For user-facing applications, provide options to view the PDF in-browser, download it, or share it via email.
  • Storage Considerations: PDF files can be large, especially for accounts with many transactions. Consider the storage implications when archiving PDFs.
  • Security: PDFs contain sensitive financial information. Ensure they are:
    • Transmitted over HTTPS
    • Stored securely with appropriate access controls
    • Protected with encryption if stored long-term
    • Deleted when no longer needed according to your data retention policy
  • Multiple Accounts: When requesting PDFs for multiple accounts (by not specifying linkRefNumber), the API may return a single consolidated PDF or multiple PDFs. Handle accordingly based on the actual implementation.
  • Date Range Validation: Ensure the transaction date range falls within the consent’s approved FI data range to avoid errors.
  • Timeout Handling: PDF generation can take longer for accounts with extensive transaction histories. Implement appropriate timeout values in your HTTP client.

​
PDF Viewing and Compatibility

The generated PDFs are compliant with standard PDF specifications and can be:
  • Viewed in any standard PDF reader (Adobe Acrobat, Preview, Chrome, Firefox, etc.)
  • Printed on standard paper sizes
  • Digitally archived for long-term storage
  • Shared via email or messaging platforms
  • Embedded in web applications using PDF viewers
The PDF format ensures consistent rendering across all devices and platforms, making it ideal for user-facing financial statements.