Getting Financial Information

Introduction

Account Aggregator is a decentralized data-sharing system that allows regulated entities to share user data amongst each other through a consent-based user flow. This data currently contains only transactional data from the bank account. Other variables are going to be added by the AA ecosystem in the future.

This API retrieves the financial details of the user.

Sample cURL Request

Preproduction

Production

curl --location 'https://api-preproduction.signzy.app/api/v3/accountAggregator/FI-fetch-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--header 'Accept: application/xml' \
--data '{   "outputFormat" : "xml",
	"consentHandleId": "a3cc0c32-1369-4dd6-bc55-dbd2ece330bc",
	"sessionId" : "3d9f8823-e845-447d-a278-5dc1bff92bbe"
}'

curl --location 'https://api.signzy.app/api/v3/accountAggregator/FI-fetch-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--header 'Accept: application/xml' \
--data '{   "outputFormat" : "xml",
	"consentHandleId": "a3cc0c32-1369-4dd6-bc55-dbd2ece330bc",
	"sessionId" : "3d9f8823-e845-447d-a278-5dc1bff92bbe"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION	TYPE
outputFormat	Required	This can have two values - "json" and "xml depending on the use case you have. To use Signzy's Banks Statement Analyzer, choose XML as output format and get the links to each accounts XML bank statement in the response as suggested below in sample response.	String
consentHandleId	Required	consent Handle id of the consent(received only when the user accepts the consent request)	String
sessionId	Required	SessionId (Unique Id to track FI request status)	String
ttl	Optional

Sample API Response

{
    "result": {
        "AAResponse": "https://preproduction-persist.signzy.tech/api/files/40716967/download/dc72f3881a8c4c779bc22b73c92164954e1f9c4f8fc8410085132d5bca92ba3f.xml",
        "accountLinks": [
            {
                "accountType": "deposit",
                "maskedAccNumber": "XXXXX1281",
                "fipName": "Finvu Bank Ltd.",
                "xmlLink": "https://preproduction-persist.signzy.tech/api/files/40716969/download/4a0be5f09b7a4688b2767d509b2370524e46144a767b4d97b54754d1905ab6cb.xml",
                "accountRefNo": "d878f3b9-3685-4018-96e6-5a5f6b7c5f5e",
                "linkRefNo": "d878f3b9-3685-4018-96e6-5a5f6b7c5f5e"
            }
        ]
    }
}

JSON Response Parameters

PARAMETER NAME	DESCRIPTION	TYPE
result	This holds the final result parameters of the response.
headers	This JSON object typically contains metadata or contextual information about the message or request being sent.
rid	It is a unique identifier generated for each request
ts	It indicates the date and time when the request was made or when the message was generated. It follows the ISO 8601 format for representing dates and times.
channelId	This field represents the channel through which the request or message is being sent. It could refer to different communication channels such as web, mobile app, or any other platform where the message originates
body	This contains the fiObjects.
fiObjects	Financial Info Object
Profile	this holds the details of the user
Holders
Holder
Holder.name	Name of the person whose financial details are being extracted	String
Holder.dob	dob of the person	String
Holder.mobile	contact number of the person	String
Holder.nominee		String
Holder.landline	landline number of the person	String
Holder.address	address of the person	String
Holder.email	email address of the person	String
Holder.pan	pan card number of the person	String
Holder.ckyccompliance		Boolean
Holders.type
Summary.pending.transactiontype		String
summary.pending.account		Float
Summary.currentBalance	the remaining balance in the person's account	String
Summary.currency		String
Summary.exchangerate		String
Summary.balanceDateTime		String
tSummary.type		String
Summary.branch		String
Summary.facility		String
iSummary.ifsccode	gives the ifsc code of the person	String
Summary.micrcode		String
Summary.openingdate		String
Summary.currentODLimit		String
Summary.drawingLimit		String
Summary.status		String
Transactions.Transaction		Array
Transactions.startDate	start date of the transcation	String
Transactions.enddate	end date of the transaction	String
Summary.type		String
Summary.maskedAccNumber		String
Summary.version		String
fiAccountInfo.inkedAccReference		String
fiAccountInfo.fipId		String
fiAccountInfo.fipName		String
fiAccountInfo.custId		String
fiAccountInfo.consentId		String
fiAccountInfo.sessionid		String
fiAccountinfo		String
accountRefNo		String

XML Response Parameters

Key	Type	Description
result	Object	Contains the result of the operation
AAResponse	String	Represents the URL for AA Response
accountLinks	Array	Contains an array of objects representing account links
accountType	String	Represents the type of account (e.g., deposit)
maskedAccNumber	String	Represents the masked account number
fipName	String	Represents the name of the FIP (Financial Institution Provider)
xmlLink	String	Represents the URL for downloading the XML file associated with the account
accountRefNo	String	Represents the reference number associated with the account
linkRefNo	String	Represents the reference number associated with the link

Error Codes

Error Code	Description
400	Bad Request: In case the request is not as per required schema or any other case
401	Unauthorized: Authentication failed or user does not have permissions for requested operation.
409	Upstream Error/Conflict: Something wrong on vendor side.
500	Internal Server Error: An error occurred on the server.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].