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 leg. Example: "2018-12-06T11:39:57.153Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
id
string (byte)
Yes
Contains consent id which is base-64 encoded unique string
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "654024c8-29c8-11e8-8868-0289437bf331"
digitalSignature
string (byte)
No
Digital Signature of the ConsentDetail Section after generation. The receiver has to verify the given signature by generating signature from the received ConsentDetail section. 'https://www.w3.org/TR/xmldsig-core1/'
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "Digital signature of the consentDetail section in the consent Artefact"
FIDataRange
Specify the queried datetime range
from
string (date-time)
Yes
Starting time for accessing the financial information. Example : "2018-11-27T06:26:29.761Z"
to
string (date-time)
Yes
Ending time to access the financial information. Example : "2018-12-27T06:26:29.761Z"
KeyMaterials
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 initiazing the encryption/decryption algorithm with common attributes. It is a Key-Value pair separated by semi colon;
DHPublicKey
Contain the Diffie-Hellman(DH) public paramters 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 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"