Fetch Data API
This API is used to fetch the financial information from the FIP against a given SessionId. It is called after the AA has received the FI-Ready notification from the FIP.
Request Parameters
Parameter Name
Data type
Required?
Description
SessionId
string (path)
Yes
The ID of the session for which information is to be fetched.
fipId
string
No
FIP ID as defined in the Account Aggregator Ecosystem. Maximum 1.
linkRefNumber
array [string]
No
linkRefNumber/s for the accounts to be fetched from particular FIP. Supports more than 1
Response Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example : "1.0"
timestamp
string (date-time)
Yes
Creation timestamp of the message which will be updated at each call. Example : "2018-11-27T06:41:54.904+0000"
txnid
string
Yes
A unique transaction identifier used for providing an end to end traceability. Containing base-64 encoded UUID string Example : "af5b8023-aabc-4a46-8f37-d3c167129b1e"
FI
Array containing the account-specific metadata with corresponding encrypted data for accessing the financial information
fipID
string
No
Example : "FIP-1"
data
Array
linkRefNumber
string
No
Example : "XXXX-XXXX-XXXX"
maskedAccNumber
string
No
Example : "XXXXXXXX4020"
encryptedFI
string (binary)
No
Contains the encrypted financial information based on the key material defined corresponding to the user’s Account
KeyMaterial
System intitilization parameters related to derive the session key and encryption key
cryptoAlg
string
Yes
Specifies the cryptographic standard algorithm used for encrypting/decrypting the financial information. Currently ECDHE is a crypto algorithm that is supported. Example : "ECDHE"
curve
string
No
Currently Curve25519 is supported. Example : "Curve25519"
params
string
No
Define the public parameters used for initializing the encryption/decryption algorithm with common attributes. It is a Key-Value pair separated by semi colon;
DHPublicKey
Contain the Diffie-Hellman(DH) public parameters information
expiry
string (date-time)
Yes
Expiry time for DH public parameters. Example : "2019-06-01T09:58:50.505Z"
Parameters
string
No
Define the Diffie-Hellman(DH) public parameters used to calculate the session (data encryption) key. For example: Ephemeral public key
KeyValue
string
No
The value of DH public parameters
Nonce
integer
Yes
Nonce is a random or pseudo-random numbers generated every time during the publishing of Ephemeral public key to ensure that old communications cannot be reused in replay attacks.
Signature
string (byte)
Yes
https://www.w3.org/TR/xmldsig-core1/ Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "Signature of AA as defined in W3C standards; Base64 encoded"
Example
Sample Request
{
sessionId:xxxxxxxxxxxxxx
}
Sample Response
{
"ver": "1.0",
"timestamp": "2018-11-27T06:41:54.904+0000",
"txnid": "af5b8023-aabc-4a46-8f37-d3c167129b1e",
"FI": [
{
"fipID": "FIP-1",
"data": [
{
"linkRefNumber": "XXXX-XXXX-XXXX",
"maskedAccNumber": "XXXXXXXX4020",
"encryptedFI": "string"
}
],
"KeyMaterial": {
"cryptoAlg": "ECDHE",
"curve": "Curve25519",
"params": "string",
"DHPublicKey": {
"expiry": "2019-06-01T09:58:50.505Z",
"Parameters": "string",
"KeyValue": "string"
},
"Nonce": 0,
"Signature": "Signature of AA as defined in W3C standards; Base64 encoded"
}
}
]
}