Decrypt the encrypted response URL received from Account Aggregator after user consent flow
| Header | Type | Required | Description |
|---|---|---|---|
client_id | string | Yes | An API key issued to your organisation for authentication purposes |
client_secret | string | Yes | A secret API key issued to your server-side application for secure authentication |
organisationId | string | Yes | A unique identifier assigned to your organisation by the platform |
appIdentifier | string | Yes | A unique identifier assigned to your client application for tracking API usage |
Content-Type | string | Yes | Must be set to application/json to specify the request body format |
success or failure.| Error Code | Message | Status | Description |
|---|---|---|---|
0 | Success | S | The user has successfully accepted the consent request and linked their accounts |
1 | Consent is rejected | F | The user explicitly rejected the consent request on the AA platform |
2 | Consent not available | F | The consent request was not found on the Account Aggregator platform |
3 | Invalid request | F | The redirection request contained invalid or malformed data |
| Error Code | Message | Status | Description |
|---|---|---|---|
4 | User authentication failed | F | The user was unable to authenticate themselves on the AA platform (e.g., wrong credentials, failed OTP) |
6 | Session timeout | F | The user did not take any action on the login page and the session expired |
| Error Code | Message | Status | Description |
|---|---|---|---|
7 | Account not discovered | F | A specific FIP ID was provided but accounts were not found at that FIP (404 error), and the user cancelled or went back from the AA page |
8 | Account not discovered | F | A specific FIP ID was provided but account discovery failed due to an error at the FIP (non-404 error), and the user cancelled or went back |
9 | Account not discovered | F | Multiple FIP IDs were provided (or none), and no accounts were discovered at any FIP due to errors or missing accounts |
| Error Code | Message | Status | Description |
|---|---|---|---|
10 | Account not linked | F | Accounts were successfully discovered, but the user did not link any accounts and the session timed out |
11 | Account not linked | F | Accounts were successfully discovered, but the user chose to cancel instead of linking any accounts |
| Error Code | Message | Status | Description |
|---|---|---|---|
12 | Account link OTP not attempted | F | Accounts were discovered and the user clicked the link button, but did not enter the OTP and then cancelled the process |
13 | Account link OTP not attempted | F | Accounts were discovered and the user clicked the link button, but did not enter the OTP and the session timed out |
14 | OTP authentication failed | F | All account linking attempts failed because the user entered incorrect OTPs, and then cancelled the process |
15 | OTP authentication failed | F | All account linking attempts failed because the user entered incorrect OTPs, and the session timed out |
16 | Account link failed | F | The user entered a valid OTP, but all account linking attempts failed at the FIP level due to system errors |
| Error Code | Message | Status | Description |
|---|---|---|---|
17 | OTP failed (some accounts) | F | Multiple FIPs were involved; some account linking attempts failed due to incorrect OTPs, and the user cancelled |
18 | OTP failed (some accounts) | F | Multiple FIPs were involved; some account linking attempts failed due to incorrect OTPs, and the session timed out |
19 | Account link failed (partial) | F | Multiple FIPs were involved; some account linking attempts failed at the FIP level, and the user cancelled |
| Error Code | Message | Status | Description |
|---|---|---|---|
20 | Unknown error | F | The Account Aggregator was unable to send any valid error code due to an unexpected system error |
status of S and errorcode of 0 indicates successful consent approval and account linking. In this case, you can proceed to fetch financial data using the consent.
status of F indicates that the consent was not successfully approved. Use the errorcode to determine the specific reason for failure and provide appropriate feedback to the user.
1: Inform the user they rejected the consent and offer to retry7-9: Suggest checking if the user has accounts at the specified FIP12-15: Guide the user on OTP verification process20: Display a generic error message and suggest contacting supporttxnid field to correlate the decrypted response with your original consent request. This is especially important in high-traffic applications where multiple consent flows may be in progress simultaneously.
userid (VUA) securely in your system as it uniquely identifies the user within the Account Aggregator ecosystem. You’ll need this for future consent requests and data fetching operations.
resdate to ensure the response is recent and not a replay attacksrcref matches your original consent handleecres for extended periodsX-RateLimit-Remaining headerX-RateLimit-Reset header