FIP API Attributes

Here, the API requests are invoked by the Account Aggregator (AA) as the sender, targeting the respective FIP endpoints.

/Accounts/discover

• Request Attributes:

  • hash(Customer.id) – A hashed identifier of the customer generated during the registration with AA, ensuring privacy while identifying the user.

• Response Attributes:

  • Count(DiscoveredAccounts) – The count of accounts discovered for the customer.

/Accounts/link

• Request Attributes:

  • hash(Customer.id) – A hashed identifier of the customer generated during the registration with AA, ensuring privacy while identifying the user..

• Response Attributes:

  • RefNumber – A Temporary reference number generated by FIP for the account linking request.

/Accounts/delink

• Request Attributes:

  • hash(Account.customerAddress) – A hashed identifier of the Customer generated during the registration with AA.

• Response Attributes:

  • AccLinkDetails.linkRefNumber – Link reference number associated with the account linkage assigned by FIP.

  • AccLinkDetails.status – Current status of the account linkage (e.g. DELINKED).

  • AccLinkDetails.customerAddress – Identifier of the Customer generated during the registration with AA.

/Accounts/link/verify

• Request Attributes:

  • refNumber – The reference number of the account linking request.

• Response Attributes:

  • Count(AccLinkDetails) – Number of linked accounts details.

  • AccLinkDetails[*].linkRefNumber – Link reference numbers of individual accounts.

  • AccLinkDetails[*].status – Status of each linked account.

  • hash(Customer.id) – Hashed identifier of the customer.

/Consent

• Request Attributes:

  • consentId – Unique identifier of the consent being created or managed.

  • status – Current state of the consent (e.g., PAUSED, ACTIVE, REVOKED, EXPIRED).

• Response Attributes: None.

/Consent/Notification

• Request Attributes:

  • ConsentStatusNotification.consentId – Identifier of the consent whose status is being notified.

  • ConsentStatusNotification.consentStatus – Current status of the consent (e.g. PAUSED, ACTIVE, REVOKED, EXPIRED).

• Response Attributes: None.

/FI/request

• Request Attributes:

  • Consent.id – Identifier of the consent under which the FI request is made.

• Response Attributes:

  • consentId – Unique identifier for the consent, returned as part of the response.

  • sessionId – Unique identifier for the FI data request session created.

/FI/fetch

• Request Attributes:

  • sessionId – Unique identifier of the FI data request session, used to fetch the financial information.

• Response Attributes: None.