FIP API Specification
Last updated
Last updated
This API enables an AA to discover accounts belonging to a customer based on the customer identifiers. A list of masked account information and corresponding linkRefNumber for each discovered account is returned based on the identifier matching logic at FIP.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
Information of the user for discovering the account/s at the FIP
API version.
"2.0.0"
Request creation timestamp.
"2023-06-26T06:41:54.904+0000"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
This block would contain the information about the customer including the identifiers & the customer address at the AA
OK
API version.
"2.0.0"
Creation timestamp of the message.
"2023-06-26T11:39:57.153Z"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
A list of discovered accounts
This API is intended to be used by AA to notify the change in consent status due to the consent management operations performed by the customer. For more details about consent notification flow, please refer FAQ section. Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
Notification about the status of consent
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T11:39:57.153Z"
The unique transaction identifier used for providing an end to end traceability.
"0b811819-9044-4856-b0ee-8c88035f8858"
Information about the notifier
Contains the Consent ID and Consent Status details.
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:13:30.967+0000"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Response description
"OK"
This API will be used by the AA to send the consent artefact to the FIP on creation.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
The Signed Consent sent by AA to FIP.
API version
"2.0.0"
The unique transaction identifier used for providing an end to end traceability.
"0b811819-9044-4856-b0ee-8c88035f8858"
Unique ID generated by AA after consent approval is given by the customer.
"XXXX-XXXX-XXXX-XXXX"
Specifies the status of consent artefact
Creation time of the Consent Artefact
"2023-06-26T11:39:57.153Z"
Consent artefact signed using JWS. See SignedConsentDetail model for consent format.
"eyJhbGciOiJSUzI1NiIsImtpZCI6IjQyNzE5MTNlLTdiOTMtNDlkZC05OTQ5LTFjNzZmZjVmYzVjZiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19.ew0KICAgICAgICAiY29uc2VudFN0YXJ0IjogIjIwMTktMDUtMjhUMTE6Mzg6MjAuMzgwKzAwMDAiLA0KICAgICAgICAiY29uc2VudEV4cGlyeSI6ICIyMDIwLTA1LTI4VDExOjM4OjIwLjM4MSswMDAwIiwNCiAgICAgICAgImNvbnNlbnRNb2RlIjogIlZJRVciLA0KICAgICAgICAiZmV0Y2hUeXBlIjogIk9ORVRJTUUiLA0KICAgICAgICAiY29uc2VudFR5cGVzIjogWw0KICAgICAgICAgICAgIlBST0ZJTEUiLA0KICAgICAgICAgICAgIlNVTU1BUlkiLA0KICAgICAgICAgICAgIlRSQU5TQUNUSU9OUyINCiAgICAgICAgXSwNCiAgICAgICAgImZpVHlwZXMiOiBbDQogICAgICAgICAgICAiREVQT1NJVCIsDQogICAgICAgICAgICAiVEVSTS1ERVBPU0lUIg0KICAgICAgICBdLA0KICAgICAgICAiRGF0YUNvbnN1bWVyIjogew0KICAgICAgICAgICAgImlkIjogImNvb2tpZWphci1hYUBmaW52dS5pbiIsDQogICAgICAgICAgICAidHlwZSI6ICJBQSINCiAgICAgICAgfSwNCiAgICAgICAgIkRhdGFQcm92aWRlciI6IHsNCiAgICAgICAgICAgICJpZCI6ICJCQVJCMEtJTVhYWCIsDQogICAgICAgICAgICAidHlwZSI6ICJGSVAiDQogICAgICAgIH0sDQogICAgICAgICJDdXN0b21lciI6IHsNCiAgICAgICAgICAgICJpZCI6ICJkZW1vQGZpbnZ1Ig0KICAgICAgICB9LA0KICAgICAgICAiQWNjb3VudHMiOiBbDQogICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgImZpVHlwZSI6ICJERVBPU0lUIiwNCiAgICAgICAgICAgICAgICAiZmlwSWQiOiAiQkFSQjBLSU1YWFgiLA0KICAgICAgICAgICAgICAgICJhY2NUeXBlIjogIlNBVklOR1MiLA0KICAgICAgICAgICAgICAgICJsaW5rUmVmTnVtYmVyIjogIlVCSTQ4NTk2NDU3OSIsDQogICAgICAgICAgICAgICAgIm1hc2tlZEFjY051bWJlciI6ICJVQkk4NTIxNzg4MTI3OSINCiAgICAgICAgICAgIH0sDQogICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgImZpVHlwZSI6ICJERVBPU0lUIiwNCiAgICAgICAgICAgICAgICAiZmlwSWQiOiAiQkFSQjBLSU1YWFgiLA0KICAgICAgICAgICAgICAgICJhY2NUeXBlIjogIlNBVklOR1MiLA0KICAgICAgICAgICAgICAgICJsaW5rUmVmTnVtYmVyIjogIlVCSTQ4NTk2NDUiLA0KICAgICAgICAgICAgICAgICJtYXNrZWRBY2NOdW1iZXIiOiAiVUJJODUyMTc4ODEyIg0KICAgICAgICAgICAgfQ0KICAgICAgICBdLA0KICAgICAgICAiUHVycG9zZSI6IHsNCiAgICAgICAgICAgICJjb2RlIjogIjEwMSIsDQogICAgICAgICAgICAicmVmVXJpIjogImh0dHBzOi8vYXBpLnJlYml0Lm9yZy5pbi9hYS9wdXJwb3NlLzEwMS54bWwiLA0KICAgICAgICAgICAgInRleHQiOiAiV2VhbHRoIG1hbmFnZW1lbnQgc2VydmljZSIsDQogICAgICAgICAgICAiQ2F0ZWdvcnkiOiB7DQogICAgICAgICAgICAgICAgInR5cGUiOiAicHVycG9zZUNhdGVnb3J5VHlwZSINCiAgICAgICAgICAgIH0NCiAgICAgICAgfSwNCiAgICAgICAgIkZJRGF0YVJhbmdlIjogew0KICAgICAgICAgICAgImZyb20iOiAiMjAxOS0wNS0yOFQxMTozODoyMC4zODMrMDAwMCIsDQogICAgICAgICAgICAidG8iOiAiMjAyMC0wNS0yOFQxMTozODoyMC4zODErMDAwMCINCiAgICAgICAgfSwNCiAgICAgICAgIkRhdGFMaWZlIjogew0KICAgICAgICAgICAgInVuaXQiOiAiTU9OVEgiLA0KICAgICAgICAgICAgInZhbHVlIjogNA0KICAgICAgICB9LA0KICAgICAgICAiRnJlcXVlbmN5Ijogew0KICAgICAgICAgICAgInVuaXQiOiAiSE9VUiIsDQogICAgICAgICAgICAidmFsdWUiOiA0DQogICAgICAgIH0sDQogICAgICAgICJEYXRhRmlsdGVyIjogWw0KICAgICAgICAgICAgew0KICAgICAgICAgICAgICAgICJ0eXBlIjogIlRSQU5TQUNUSU9OQU1PVU5UIiwNCiAgICAgICAgICAgICAgICAib3BlcmF0b3IiOiAiPiIsDQogICAgICAgICAgICAgICAgInZhbHVlIjogIjIwMDAwIg0KICAgICAgICAgICAgfQ0KICAgICAgICBdDQogICAgfQ.O3KPh-eTpW2w47QXYidOBe1Hk2y7djVAEcOnZyRRvxQ3cY18-9ZWiodF16jff-e7yNQgsYZpAy95Fx2Fft8LoYugkYh9_6qHiG_7LCtW8Ng4nCMgZM3Wwsj11ks1msrK5C1ksPrGlTkFhm9-FufNkPTAlW76_5Sb8G_lOsIj1lB8TrvKpOvPlhEIgsS4WBNdPfv3SBqTV2suw2LvkX3QTilqwuMgXMkrm9-RYL90fweX_yyoyaBWHOJNQaKNuQWPpoRRNHGOx3v4_QiwgrELdfeTVtKn6R_AsfaBoEthQ3wrc8tY1q0Wx5j0x18NdU2R2C26dHyZ9M11dEH99psA1A"
Section defining the parameters for consent tracking
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:13:30.967+0000"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Response description
"OK"
This API can be used by the AAs to check availability of the FIP application.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:54:54.435Z"
Status of the FIP application
This API will be used to delete a previously established account link to the user's profile. Once deleted, the financial information can not be retrieved for that account through Account Aggregator.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T17:51:18.412Z"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T10:27:17.699+0000"
Unique transaction identifier used for providing an end to end traceability.
"410c2d2e-4a1e-11e8-960e-0277a9fbfedc"
This API will be used for initiating an account link request to link selected account/s with the AA customer address. Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
API version
"2.0.0"
Current Timestamp
"2023-06-26T17:51:18.412Z"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Customer identifiers including AA virtual address.
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:13:30.967+0000"
Unique transaction identifier used for providing an end to end traceability.
"f35761ac-4a18-11e8-96ff-0277a9fbfedc"
There are two kinds of authentications that the FIP may support (1) Direct Authentication- The FIP obtains confirmation through a direct interaction with the customer. (2) Token-based Authentication- In this case, a token (e.g., a short-lived one-time password) is issued to the customer, which the customer can then supply to the AA for subsequently forwarding to the FIP.
"TOKEN"
Temporary reference number generated by FIP for account linking request
"f6b1482e-8f08-11e8-862a-02552b0d3c36"
This API is used to submit the token/OTP(received from the customer) back to FIP so that account linkage can be completed. It is used only in case of token-based authentication for linking accounts. Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T10:27:17.699+0000"
Unique transaction identifier used for providing an end to end traceability.
"410c2d2e-4a1e-11e8-960e-0277a9fbfedc"
Temporary reference number generated by FIP for account linking request
"f6b1482e-8f08-11e8-862a-02552b0d3c36"
The token that was sent to the customer by the FIP to confirm account link activity
999999
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T10:27:17.699+0000"
Unique transaction identifier used for providing an end to end traceability.
"410c2d2e-4a1e-11e8-960e-0277a9fbfedc"
Linked account details.
This API is used to fetch financial information from FIP once AA recieves the data ready notification.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:41:34.904+0000"
Unique transaction identifier used for providing an end to end traceability.
"af5b8023-aabc-4a46-8f37-d3c167129b1e"
A session ID is a base-64 encoded UUID number that FIP returns to the AA for each financial information access request.
"caa2f259-2dc2-4075-87aa-6d81018b6183"
FIP ID as defined in the Account Aggregator Ecosystem.
"FIP-1"
Reference number assigned by FIP as part of Account Linking Process.
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T06:41:54.904+0000"
The unique transaction identifier used for providing an end to end traceability.
"af5b8023-aabc-4a46-8f37-d3c167129b1e"
Contains the account-specific metadata with corresponding encrypted data for accessing the financial information
This API is used by the AA to request for financial information from the FIP. The FIP will validate the request against the signed consent and return a sessionID which can then be used by the AA to fetch the required data.
Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.
Initialization parameters for requesting the financial information
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T09:58:50.505Z"
Unique transaction identifier used for providing an end to end traceability.
"c4a1450c-d08a-45b4-a475-0468bd10e380"
Consent Artefact details.
Specifies the date time range for which the financial information is requested
Contains the cryptographic parameters that are required to perform End-to-End encryption for sharing the financial information between the producer and the consumer in a secure manner. Please refer this link for more information: https://tools.ietf.org/html/rfc4492
OK
API version
"2.0.0"
Creation timestamp of the message.
"2023-06-26T10:05:50.505Z"
Unique transaction identifier used for providing an end to end traceability. Base-64 encoded UUID
"c4a1450c-d08a-45b4-a475-0468bd10e380"
Unique ID generated by AA after consent approval is given by the customer.
"654024c8-29c8-11e8-8868-0289437bf331"
A session ID is a base-64 encoded UUID number that FIP returns to the AA for each financial information access request.
"caa2f259-2dc2-4075-87aa-6d81018b6183"