Consent Data

Introduction

Returns the fetched financial data for one consent, across all of its banks.

How to call the API

Send a POST request with your Signzy API key in the Authorization header and Content-Type: application/json.

Authorization: Content-Type: application/json

API Input Guidelines

You need to pass the following information:

consentHandle — a handle from the consents[] array returned by the start (or status) call.

Sample Curl

Preproduction

Production

curl -X POST "https://api-preproduction.signzy.app/api/v3/aa-switch/consent/data" \
  -H "Authorization: <signzy-api-key>" \
  -H "Content-Type: application/json" \
  -d '{ "consentHandle": "<consenthandle generated in consent start api >"}'

curl -X POST "https://api.signzy.app/api/v3/aa-switch/consent/data" \
  -H "Authorization: <signzy-api-key>" \
  -H "Content-Type: application/json" \
  -d '{ "consentHandle": "<consenthandle generated in consent start api>"}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
consentHandle	Required	A consent handle from the consents[] array returned by start / status.

Sample Response

{
  "event": "dataReady",
  "journeyId": "ced8893d-7a17-4500-b90c-a87d812ab62f",
  "consentHandle": "1c6e9316-dd93-424a-9d98-d9f4e82d2564",
  "sessionId":"",
  "status": {
    "journeyStatus": "SUCCESS",
    "consentStatus": "ACTIVE",
    "fips": [
      {
        "fipId": "fip@finbank",
        "dataFetchStatus": "SUCCESS"
      }
    ]
  },
  "accountCount": 2,
  "data": [
    {
      "fipId": "fip@finbank",
      "type": "deposit",
      "fiData": [
        {
          "linkedAccRef": "6de5df7d-5df8-4997-aaa3-42cbe77296d5",
          "maskedAccNumber": "FNRKXXXXXXX5876",
          "type": "deposit",
          "version": "1.1",
          "pdfUrl":"",
          "profile": {
            "holders": {
              "type": "SINGLE",
              "holder": {
                "name": "Tony Stark",
                "dob": 1032825600000,
                "mobile": "7470485703",
                "landLine": "",
                "nominee": "NOT-REGISTERED",
                "email": "[email protected]",
                "pan": "ABCDE1234F",
                "ckycCompliance": true,
                "address": "Milkyway, 4th arm"
              }
            }
          },
          "summary": {
            "currentBalance": "62146.62",
            "currency": "INR",
            "exchgeRate": "",
            "balanceDateTime": 1783074884000,
            "type": "SAVINGS",
            "accountSubType": "",
            "branch": "Jayanagar 4th Block",
            "facility": "OD",
            "ifscCode": "ICIC0001124",
            "micrCode": "500240246",
            "openingDate": "2004-08-06",
            "currentODLimit": "0",
            "drawingLimit": "0",
            "status": "ACTIVE",
            "pending": [
              {
                "transactionType": "DEBIT",
                "amount": 0
              }
            ]
          },
          "transactions": {
            "startDate": "030525",
            "endDate": "030726",
            "transactions": [
               {
                "accountType": "DEPOSIT",
                "txnId": "txn0000000001",
                "type": "DEBIT",
                "mode": "UPI",
                "narration": "UPI/964640483337/SWIGGY/swiggy@ybl/INDBNK",
                "amount": 53.09,
                "currentBalance": 239.8,
                "reference": "REF69962606",
                "transactionTimestamp": "2025-08-27T00:00:00.000Z",
                "valueDate": "2025-08-27"
              },
              {
                "accountType": "DEPOSIT",
                "txnId": "txn0000000002",
                "type": "DEBIT",
                "mode": "IMPS",
                "narration": "IMPS/355996674763/FLIPKART",
                "amount": 63.12,
                "currentBalance": 176.68,
                "reference": "REF81976353",
                "transactionTimestamp": "2025-08-27T00:00:00.000Z",
                "valueDate": "2025-08-27"
              },
              {
                "accountType": "DEPOSIT",
                "txnId": "txn0000000003",
                "type": "CREDIT",
                "mode": "IMPS",
                "narration": "IMPS/870996937745/AMAZON",
                "amount": 27.49,
                "currentBalance": 204.17,
                "reference": "REF31789499",
                "transactionTimestamp": "2025-08-28T00:00:00.000Z",
                "valueDate": "2025-08-28"
              }
            ]
          }
        },
        {
          "linkedAccRef": "90c53c25-28d3-4407-b72e-0ee8c7de59d6",
          "maskedAccNumber": "FNRKXXXXXXX5877",
          "type": "deposit",
          "version": "1.1",
          "pdfUrl":"",
          "profile": {
            "holders": {
              "type": "SINGLE",
              "holder": {
                "name": "Tony Stark",
                "dob": 1032825600000,
                "mobile": "7470485703",
                "landLine": "",
                "nominee": "NOT-REGISTERED",
                "email": "[email protected]",
                "pan": "ABCDE1234F",
                "ckycCompliance": true,
                "address": "Milkyway, 4th arm"
              }
            }
          },
          "summary": {
            "currentBalance": "1280136.42",
            "currency": "INR",
            "exchgeRate": "",
            "balanceDateTime": 1783074884000,
            "type": "SAVINGS",
            "accountSubType": "",
            "branch": "Jayanagar 4th Block",
            "facility": "OD",
            "ifscCode": "ICIC0001124",
            "micrCode": "500240246",
            "openingDate": "2000-09-06",
            "currentODLimit": "0",
            "drawingLimit": "0",
            "status": "ACTIVE",
            "pending": [
              {
                "transactionType": "DEBIT",
                "amount": 0
              }
            ]
          },
          "transactions": {
            "startDate": "030525",
            "endDate": "030726",
            "transactions":[
               {
                "accountType": "DEPOSIT",
                "txnId": "txn2009261813",
                "type": "DEBIT",
                "mode": "UPI",
                "narration": "UPI/109406211084/Auto/amzn0020388725@/Kotak Mahind",
                "amount": 96,
                "currentBalance": 281690.73,
                "reference": "REF07510140",
                "transactionTimestamp": "2025-05-04T07:36:16.000Z",
                "valueDate": "2025-05-04"
              },
              {
                "accountType": "DEPOSIT",
                "txnId": "txn8221413661",
                "type": "DEBIT",
                "mode": "UPI",
                "narration": "UPI/109412355999/Meds/gpay-1118037476/Axis Bank Lt",
                "amount": 53.4,
                "currentBalance": 281637.33,
                "reference": "REF03690159",
                "transactionTimestamp": "2025-05-04T08:46:41.000Z",
                "valueDate": "2025-05-04"
              },
              {
                "accountType": "DEPOSIT",
                "txnId": "txn4773422124",
                "type": "DEBIT",
                "mode": "UPI",
                "narration": "UPI/109416888775/Zipcash card se/ola.money1@axis/A",
                "amount": 99,
                "currentBalance": 281538.33,
                "reference": "REF03496407",
                "transactionTimestamp": "2025-05-04T10:04:16.000Z",
                "valueDate": "2025-05-04"
              }
            ]
          }
        }
      ]
    }
  ],
  "fetchInProgress": false
}

Response Parameter

PARAMETER NAME	TYPE	DESCRIPTION
consentHandle	String	Unique identifier for the consent used to fetch financial information.
status	Object	Overall status of the consent and data fetch process
status.journeyStatus	String	Status of the overall AA journey (e.g.SUCCESS, FAILED, IN_PROGRESS).
status.consentStatus	String	Current status of the consent (e.g.ACTIVE, PENDING, REVOKED, DENIED, EXPIRED).
status.fips	Array<Object>	List of Financial Information Providers (FIPs) involved in the request.
status.fips[].fipId	String	Identifier of the Financial Information Provider.
status.fips[].dataFetchStatus	String	Data fetch status for the corresponding FIP.
accountCount	Integer	Total number of accounts returned across all FIPs.
data	Array<Object>	List of financial information grouped by FIP.
data[].fipId	String	Identifier of the Financial Information Provider.
data[].type	String	Type of financial information (e.g. deposit).
data[].fiData	Array<Object>	List of accounts returned by the FIP.
data[].fiData[].linkedAccRef	String	Unique reference ID of the linked account.
data[].fiData[].maskedAccNumber	String	Masked account number for display purposes.
data[].fiData[].type	String	Type of account (e.g. deposit).
data[].fiData[].version	String	FI schema version used by the FIP.
data[].fiData[].pdfUrl	String	pdf url of account data, empty string if includePdf is not passed in consent start API
data[].fiData[].profile	Object	Account holder profile information.
data[].fiData[].profile.holders.type	String	Ownership type of the account (e.g. SINGLE, JOINT).
data[].fiData[].profile.holders.holder	String	Details of the account holder.
name	String	Name of the account holder.
dob	Long Number	Account holder's date of birth in Unix epoch milliseconds.
mobile	String	Registered mobile number.
landLine	String	Registered landline number.
nominee	String	Nominee registration status.
email	String	Registered email address.
pan	String	PAN of the account holder.
ckycCompliance	Boolean	Indicates whether CKYC compliance is completed.
address	String	Registered address of the account holder.
summary	Object	Current account summary information.
summary.currentBalance	String	Current available balance.
summary.currency	String	Currency code of the account balance (e.g. INR).
summary.exchgeRate	String	Exchange rate, if applicable.
summary.balanceDateTime	Long Number	Timestamp when the balance was recorded (epoch milliseconds).
summary.type		Account type (e.g. SAVINGS, CURRENT, REGULAR).
summary.accountSubType		Additional classification of the account.
summary.branch		Name of the account branch.
summary.facility	String	Banking facility associated with the account (e.g., OD, OVERDRAFT).
summary.ifscCode	String	IFSC code of the branch.
summary.micrCode	String	MICR code of the branch.
summary.openingDate	String	Account opening date in YYYY-MM-DD format.
summary.currentODLimit	String	Current overdraft limit available.
summary.drawingLimit	String	Drawing limit of the account.
summary.status	String	Current account status (e.g. ACTIVE, CLOSED).
summary.pending	Array<Object>	List of pending transactions, if any.
summary.pending[].transactionType	String	Type of pending transaction (DEBIT or CREDIT).
summary.pending[].amount	Number	Pending transaction amount.
transactions	Object	Transaction history for the account.
transactions.startDate	String	Start date of the transaction period (DDMMYY).
transactions.endDate	String	End date of the transaction period (DDMMYY).
transactions.transactions	Array<Object>	List of transactions for the account.
transactions.transactions[].accountType	String	Account category associated with the transaction.
transactions.transactions[].txnId	String	Unique transaction identifier.
transactions.transactions[].type	String	Transaction type (DEBIT or CREDIT).
transactions.transactions[].mode	String	Payment mode (e.g. UPI, IMPS, NEFT, OTHERS).
transactions.transactions[].narration	String	Transaction description or remarks.
transactions.transactions[].amount	Number	Transaction amount.
transactions.transactions[].currentBalance	Number	Account balance immediately after the transaction.
transactions.transactions[].reference	String	Transaction reference number.
transactions.transactions[].transactionTimestamp	DateTime String	Exact transaction timestamp in ISO 8601 UTC format.
transactions.transactions[].valueDate	Date String	Effective value date of the transaction in YYYY-MM-DD format.
fetchInProgress	Boolean	Indicates whether account data fetching is still in progress ( true) or has completed (false).