ver | string | Yes | The version number of the API specification being used in this response. | e.g., “1.21.0” |
status | string | Yes | Indicates whether the request was processed successfully or encountered an error. | success, failure |
data | array | Yes | An array of account objects, each containing incremental data for a linked account. | Array of account data objects |
data[].linkReferenceNumber | string | Yes | The unique identifier linking this specific account to the consent. This reference is generated when an account is linked through the AA flow. | UUID format |
data[].maskedAccountNumber | string | Yes | The account number with most digits masked for security purposes, typically showing only the last 4 digits. | e.g., “XXXXXXXX3900” |
data[].fiType | string | Yes | Categorizes the type of financial information being shared from this account. | DEPOSIT, TERM_DEPOSIT, TERM-DEPOSIT, RECURRING_DEPOSIT, SIP, CP, GOVT_SECURITIES, EQUITIES, BONDS, DEBENTURES, MUTUAL_FUNDS, ETF, IDR, CIS, AIF, INSURANCE_POLICIES, NPS, INVIT, REIT, GSTR1_3B, LIFE_INSURANCE, GENERAL_INSURANCE, OTHER |
data[].bank | string | Yes | The name of the financial institution (bank or Financial Information Provider) holding this account. | e.g., “FinShareBankServer” |
data[].Profile | object | Yes | Contains comprehensive profile information about the account holder(s), including personal details and KYC status. | Profile object |
data[].Profile.Holders.type | string | Yes | Indicates whether the account has a single owner or multiple joint holders. | SINGLE, JOINT |
data[].Profile.Holders.Holder | object/array | Yes | Details about the account holder(s). For SINGLE type, this is an object; for JOINT type, this is an array of holder objects. | Holder object(s) |
data[].Profile.Holders.Holder.name | string | Yes | The full legal name of the account holder as registered with the financial institution. | Full name string |
data[].Profile.Holders.Holder.dob | string | Yes | The account holder’s date of birth, used for identity verification and KYC compliance. | Date string (YYYY-MM-DD format) |
data[].Profile.Holders.Holder.mobile | string | Yes | The primary mobile number registered with the account, may be partially masked for privacy. | Mobile number string |
data[].Profile.Holders.Holder.nominee | string | Yes | Indicates whether a nominee has been registered for this account, important for succession planning and compliance. | Registered, Not-Registered |
data[].Profile.Holders.Holder.landline | string | Yes | The landline contact number if available, may be empty or partially masked. | Landline number string |
data[].Profile.Holders.Holder.address | string | Yes | The complete registered address for the account holder, may be partially masked for privacy. | Address string |
data[].Profile.Holders.Holder.email | string | Yes | The email address registered with the account, may be partially masked. | Email string |
data[].Profile.Holders.Holder.pan | string | Yes | The Permanent Account Number (PAN) issued by the Income Tax Department of India, used for tax compliance and identity verification. | PAN format string (e.g., “ABCDE1234F”) |
data[].Profile.Holders.Holder.ckycCompliance | string | Yes | Indicates whether the Central KYC (CKYC) verification has been completed for this account holder, ensuring regulatory compliance across financial institutions. | YES, NO, NO_DATA_AVAILABLE |
data[].Summary | object | Yes | Provides a consolidated snapshot of the account’s current state, including balance and account characteristics. | Summary object |
data[].Summary.currentBalance | string | Yes | The account balance as of the most recent update, represented as a string to preserve decimal precision. | Numeric string (e.g., “101666.33”) |
data[].Summary.currency | string | Yes | The currency code in which the account balance is denominated. | ISO 4217 currency codes (e.g., “INR”, “USD”) |
data[].Summary.exchgeRate | string | Yes | The exchange rate applied if currency conversion is relevant, typically “1.0” for domestic accounts. | Numeric string |
data[].Summary.balanceDateTime | string | Yes | The exact timestamp when the current balance was calculated or last updated by the financial institution. | ISO 8601 timestamp |
data[].Summary.type | string | Yes | The operational classification of the account, determining transaction rules and features available. | SAVINGS, CURRENT |
data[].Summary.branch | string | Yes | The branch name or code where the account is held, useful for identifying the servicing location. | Branch identifier string |
data[].Summary.facility | string | Yes | Additional banking facilities associated with the account, such as overdraft protection. | e.g., “OD” (Overdraft), or empty string |
data[].Summary.ifscCode | string | Yes | The Indian Financial System Code uniquely identifying the bank branch, essential for electronic fund transfers (NEFT, RTGS, IMPS). | IFSC format string (e.g., “HDFC0001234”) |
data[].Summary.micrCode | string | Yes | The Magnetic Ink Character Recognition code printed on cheques, used for check processing and clearance. | MICR format string (9 digits) |
data[].Transactions | object | Yes | Contains the incremental transaction data retrieved since the last fetch, organized by transaction type and time period. | Transactions object |