API
← Back HomeNPMDeveloper HubAPIBlog

Connect API

The test data that we provide for the Connect API service (below) has been designed to mimic a real life user. This means that just a like a real user would spend and receive funds throughout the day - our test accounts have been designed to do the same thing. Therefore you should expect to see new transaction records being created throughout the day, and the account balances adjusted accordingly.

This should give you a good feel for the type of data that you should expect to see for your own customers. The transaction data is completely random, and even we are sometimes surprised by transactions that appear :-)

🚧

You can use our sandbox environment for free right now - just grab an API key to get started (via the Developer Dashboard).

📘

Ensure that you pass the institution code AU00000 when using the test accounts. Data for sandbox accounts is updated daily/weekly/monthly to provide realistic data for faster integration.

loginId

password

great for...

Wentworth-Smith

whislter

Connect and Affordability - happy path persona with steady income, mortgage, credit card and predictable expenses

Whistler

ShowBox

Connect and Affordability - persona with income, missing expenses, BNPL activity and balance going up over time

Gilfoyle

PiedPiper

new Connect and Affordability - persona with balances ranging between stable and diminishing over time

gavinBelson

hooli2016

Connect

richard

tabsnotspaces

Connect

jared

django

Connect

MFA users

We have two test banks to test MFA challenges

  • Pied Piper Bank: AU00002 (mfa-challenge always)
  • Nucleus Bank: AU00003 (mfa-challenge intermittent - 50/50)

loginId

password

mfaChallengeMethod

mfaChallengeInput

mfaChallengeSolution

jared

django

token

["OTP Password"]

["1234"]

richard

tabsnotspaces

token

["OTP Password"]

["1234"]

gavinBelson

hooli2016

security-questions

["What's your first company?"

["Hooli"]

Gilfoyle

PiedPiper

security-questions

["What's your first company?"]

["Hooli"]

Whistler

ShowBox

security-questions

["What's your favourite company?", "What's the ID of this institution?"]

["Basiq", "AU00000"]

Wentworth-Smith

whislter

security-questions

["What's your favourite company?", "What's the ID of this institution?"]

["Basiq", "AU00000"]

Unhappy path test users

🚧

The following users will always return the same errors at the same job step. We created them to ensure you could fully test the unhappy paths your user may encounter while connecting their accounts and handle them appropriately. See here on how to best handle these scenarios.

loginID

password

Failure scenario

bighead

password

Error: invalid-credentials
Detail: "Account is locked"

erlich

aviato

Error: account-not-accessible-requires-user-action
Detail: "An action is required from end-user before account details can be returned."

jianYang

nothotdog

Error: service-unavailable
Detail: "Service is currently unavailable. Please try again later."

📘

Whistler login - sandbox data

This user in sandbox has examples of the following:

  • Regular income over the last 13 months that shows some instability, e.g. some time spent as a casual worker, which then produces a stability score of < 0.8, and a more varied income/month graph
  • Gambling expenditure 
  • BNPL activity
  • Higher than expected expenditure in some categories e.g. alchohol
POST /users/ea3a81/connections HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN                                           
Content-Type: application/json

{
 "loginId": "Wentworth-Smith",
 "password": "whislter",
 "institution":{
   "id":"AU00000"
 }
}