Error Codes
Error Handling
Errors can be outputted at all steps of the application process. It is quite possible that errors will be returned whilst the application is still capable of being run, i.e. incorrect login details. These error codes are used to keep you apprised of any issues with the application process.
Bolded errors are the most basic error response. These are rarely used, if possible we will provide an error code under it identifying the issue more explicitly, if available.
Error Codes
| Error Code | Code Description | Description Breakdown |
|---|---|---|
| 1000 | Bank login error. | |
| 1001 | Incorrect login details have been provided by the user. | This error usually appears in tandem with an auth request allowing the user to retry their login details. |
| 1002 | Exceeded login attempts. | In this case the user has incorrectly inputted their login details too many times and the bank has potentially locked us out of the account. |
| 1003 | Locked bank account. | This means that the bank has locked us out of the account. This could be for a number of different reasons, from too many incorrect login attempts, or running out of time in inputting a verification code |
| 1004 | SMS code suspended. | This means that the SMS code that the user provided has expired and is not usable by us to access the account. |
| 1005 | SMS Exceeded Retry Attempts. | In this case, too many SMS code attempts have been tried to access the account, all of which were incorrect. This usually comes with a locked bank account (1003) notice straight after |
| 1006 | Account has been suspended. | In this case, the credentials we've been provided have been to a bank account that has been suspended by the banking institution hosting it. This can be for any number of reasons, from potential fraud to the user just shutting down the account previously. |
| 1007 | Additional inputs required. | This is a warning notifying you that a third input is required to authenticate the user. This could be because of MFA (multifactor authentication). Some banks, such as Bank of Melbourne, require this to be the default. |
| 1008 | Requesting users initial credential inputs. | This message is notifying you that the username and password have not been submitted yet to log in to this account. |
| 1009 | User exit. | User has left the system before all transactions were successfully completed. |
| 1010 | Unable to find mobile bank | Unable to use mobile bank login. Please use website login credentials. |
| 2000 | Bank requires user input. | |
| 2001 | Need to login and update personal details. | Usually occurring on new accounts, this a pop-up that can occur on some banks requiring that the user login and provide their personal details for the bank. |
| 2002 | Login and agree to terms | Usually this is the bank updating its terms and conditions and requiring that the user accept before they can access their account. As such, we cannot access the system until this is completed by the user. |
| 2003 | You need to set a permanent password with the bank. | This notice appears when the account has only recently been made by the user. Some banks will provide a temporary password that must be changed to a permanent one on the first login. As we cannot set a user's password they must log in and do this themselves before our system can continue. |
| 2004 | Could not process MFA. | This means that the response sent by the user in return to an MFA request (1007) was incorrect. |
| 2005 | Verify Account. | Similar to 2003, this usually occurs on new accounts that haven't been verified by the user in the first login. |
| 2006 | Password change required | Usually occurs with banks that have a regular password change policy. |
| 3000 | Timed Out. | |
| 3001 | Network timed out - try again in a minute. | Connection to the bank failed due to network failure. |
| 3002 | User input time out - session has been ended. | This notice is sent when the session has timed out for any other reason except for waiting on inputs. |
| 3003 | User input time out - user took too long to input credentials. | This error is sent after the session has expired whilst waiting for the user to input their username and password. |
| 3004 | Session timed out - user took too long to input MFA. | This error is sent after the session has expired whilst waiting for the user to input their multifactor authentication request (e.g. SMS, dob, secret question) |
| 3005 | Session has logged out during crawl | This is sent when the bank logs us out of the system. This usually occurs due to the user logging in themselves. |
| 3006 | Timed out before AUTH | A specific error showing when the time out for the bank crawl occurred. In this case before AUTH lifecycle. |
| 3007 | Timed out during AUTH | A specific error showing when the time out for the bank crawl occurred. In this case during AUTH lifecycle. |
| 3008 | Timed out after RELEASED | A specific error showing when the time out for the bank crawl occurred. In this case after the RELEASED lifecycle |
| 4000 | Problem retrieving information. | |
| 4001 | The bank accounts have been closed. | This notice is sent when the bank account that is being processed is listed as closed. Closed accounts can sometimes not be accessed for data. |
| 4002 | Bank system is being updated and cannot be accessed. | Sent when the bank is undergoing a system update. These happen semi-frequently for each bank, but are during off hours late at night so it is unlikely that you will receive this message often. |
| 4003 | The request cannot be completed as a subsequent login was attempted. | Similar to 3005, this notice is sent when it is known that the reason we were logged out was due to another login attempt. |
| 4004 | Supplied bank credentials have expired. | Sent when the username/password combination is an old one. |
| 4005 | Online banking setup has not yet been finalized. | This notice is sent when the initial banking setup for the account has not yet been completed. This is usually an indication that the account is very new. |
| 4006 | You are not registered for this service. | This notice is sent when the user no longer has an account with the bank we are trying access, or if they have deliberately removed access to the online banking component of their service. If this returned with Centrelink, it is possibly due to them never having had a Centrelink account set up. |
| 4007 | Found no data in all of the accounts | Found no data in all of the accounts. That is, the total number of transactions is 0. The balance of all accounts is 0. Sometimes seen in disabled, hidden, or new accounts. |
| 4008 | Bank is currently unable to provide transactions | An issue with the bank has prevented collection of transactions. |
| 4009 | Bank is currently unable to provide statements | An issue with the bank has prevented collection of statements. |
| 4010 | Bank is currently unable to provide interims | An issue with the bank has prevented collection of interims. |
| 4011 | User bank account does not contain any accounts. Unable to collect accounts or transactions | The account has no accounts to collect data from. |
| 4012 | User bank account does not contain any data within the specified date range. | There may be transactions in the account however not within the specified days to retrieve. |
| 4013 | Bank is currently unable to provide account balances. | An issue with the bank has prevented collection of account balances. |
| 4014 | Please login and change your document delivery option to digital one. | The document delivery option should be set to the digital one. |
| 4015 | Your vehicle registration needs to be renewed. | The vehicle registration needs to be renewed. |
| 4016 | This acccount have already been registered under other names. | This account is already associated with different names. |
| 4017 | This MyGov account has not linked any ATO/CentreLink/Medicare service yet. | MyGov accounts should be linked to ATO/CentreLink/Medicare to get access to these services. |
| 4018 | Mygov service is offline now. Please check their website for more information. | Mygov service is currently unavailable. |
| 4019 | ATO site is having technical difficulties and cannot provide transaction details. | ATO service is currently unavailable. |
| 4020 | Centrelink service is offline due to maintenance. | Centrelink service is under maintenance. |
| 4021 | Centrelink service is not linked to your myGov account. | Centrelink service should be linked to myGov account before processing. |
| 4022 | ATO service is not linked to your myGov account. | ATO service should be linked to myGov account before processing. |
| 5000 | Network issues. | |
| 5001 | Bank service is currently unavailable. | Sent when the system is down on the banks end outside of their system update schedule. |
| 5002 | Bankmodule not available, coming soon. | Sent when the bank that is being requested is not currently supported within the system. |
| 5003 | Bank is currently unable to provide transaction history at this time | Usually when an issue with the bank system prevents transaction data from being retrieved. |
| 5004 | Logged out during crawl and unable to relogin | An error occurred during the crawl and we were unable to continue, usually due to MFA. |
| 6000 | Unable to retrieve statements. | |
| 7000 | Try again tomorrow. | |
| 7001 | Something went wrong. Try again. | Sent when another login is required on a refresh, or when an error occurs that would be resolved upon recrawling. |
| 8000 | Cannot assist right now. | |
| 8001 | Unknown error. | Generic error. Sent when something very unusual has happened that hasn't been pinpointed. This is flagged in our system for us to investigate. |
| 8002 | An error occurred when processing this account. | Generic error. Sent when something very unusual has happened that hasn't been pinpointed. This is flagged in our system for us to investigate. |
Example Payload
1{
2 "event": "crawler.lifecycle_updated",
3 "payload": {
4 "uuid": "b18fd94f-a1b8-4572-965d-3ba16a70c7ed",
5 "vendor_specific_id": "200130a",
6 "bank_id": 130,
7 "timestamp": "2020-01-30T00:30:23.724232Z",
8 "status": "AUTH",
9 "code": 1001,
10 "message": "Incorrect Login details"
11 }
12}