---
updatedAt: 2026-05-20T05:20:58.000Z
agentTools:
projectIndex: https://api.basiq.io/llms.txt
---
# Quickstart: API
Make your first call to the Basiq API.
Β
## STEP 1: Register
To begin, register your application via our [dashboard](https://dashboard.basiq.io/) and configure it accordingly. Before proceeding to create a new API key, ensure your application settings are in order.
> π API Keys
>
> You can create as many API keys as you want, which allows you to use keys across different applications and environments. Itβs a good idea to give each API key a meaningful name in order to differentiate between them.
> π§ Keep your key secret
>
> Make sure you copy and save the key we give you straight away, as it will only be exposed it in full once. Your API keys carry many privileges, so be sure to keep them secret!
>
> Do not share your API keys in publicly accessible areas such GitHub, client-side code, etc
## STEP 2: Authenticate
Exchange your newly acquired API key for an access token. This token enables secure interactions with the Basiq API and expires every 60 minutes. We recommend storing it globally and refreshing it 2-3 times per hour.
> π Scope
>
> The scope you supply will depend on the action you are performing, see the [authentication section](https://api.basiq.io/reference/authentication) for further detail. For this quick start we will be using `SERVER_ACCESS`.
> π§ API key format β do not Base64-encode
>
> The API key is passed **verbatim** as the Basic auth value. Unlike standard HTTP Basic Auth, there is no `base64(username:password)` encoding step β use the key exactly as issued from the dashboard. Encoding the key will result in a `400` error.
```javascript STEP 2: Authenticate
var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
'scope': 'SERVER_ACCESS'
})
var config = {
method: 'post',
url: 'https://au-api.basiq.io/token',
headers: {
'Authorization': `Basic ${YOUR_API_KEY}`,
'Content-Type': 'application/x-www-form-urlencoded',
'basiq-version': '3.0'
},
data : data
};
axios(config)
.then((response) => {
console.log(response.data)
})
.catch((error) => {
console.log(error)
})
```
```curl
curl --location --request POST 'https://au-api.basiq.io/token' \
--header 'Authorization: Basic $YOUR_API_KEY' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'basiq-version: 3.0' \
--data-urlencode 'scope=SERVER_ACCESS'
```
## STEP 3: Create a user
Creating a user establishes a repository for all financial data. Upon successful creation, you'll receive a userId. With this and the previously acquired access token, you possess all the necessary components to commence creating and fetching financial data.
```javascript STEP 3: Create a user
var axios = require('axios');
var data = JSON.stringify({
"email": "max@hooli.com",
"mobile": "+614xxxxxxxx"
});
var config = {
method: 'post',
url: 'https://au-api.basiq.io/users',
headers: {
'Authorization': 'Bearer $YOUR_ACCESS_TOKEN',
'Accept': 'application/json',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(function (response) {
console.log(response.data);
})
.catch(function (error) {
console.log(error);
});
```
```curl
curl --location --request POST 'https://au-api.basiq.io/users' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "max@hooli.com",
"mobile": "+614xxxxxxxx"
}'
```
#### **Congratulations!** You have registered your application, and made your first, authenticated call to Basiq to create a user!
## STEP 4: Consent & Connect via the Consent UI
Before you can retrieve a users financial data, you first need to link to their financial institutions by creating a connection. This can only be done once a user has explicitly consented to share their data. This can be done via the [Basiq Consent UI](https://api.basiq.io/docs/consent#consent-ui). While you are starting out in sandbox mode, use the institutions and credentials provided [here](https://api.basiq.io/reference/testing).
```javascript STEP 4: Create a connection
// STEP 4: Consent & Create a connection
window.location = `https://consent.basiq.io/home?token={{client_token_bound_to_userId}}`;
```
```curl CLIENT token bound to userID
curl --location --request POST 'https://au-api.basiq.io/token' \
--header 'Authorization: Basic [YOUR-API-KEY]' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'basiq-version: 3.0' \
--data-urlencode 'scope=CLIENT_ACCESS' \
--data-urlencode 'userId=1234567-1234-1234-1234-123456781234'
```
## STEP 5: Fetch Job History
After completing the consent journey and creating a connection, the consent UI will return a jobID or multiple jobIds if there are multiple connections in the consent UI.
Use the following cURL command to fetch job history:
```curl
curl --request GET \
--url https://au-api.basiq.io/jobs/jobId \
--header 'accept: application/json'
```
The job response will contain three steps associated if this is a data connector job.
```json
{
"type": "job",
"id": "e9132638",
"created": "2020-06-10T09:59:00Z",
"updated": "2020-06-10T09:59:00Z",
"steps": [
{
"title": "verify-credentials",
"status": "success",
"result": {
"type": "link",
"url": "/users/ea3a81/connections/8fce3b"
}
},
{
"title": "retrieve-accounts",
"status": "in-progress",
"result": null
},
{
"title": "retrieve-transactions",
"status": "pending",
"result": null
}
],
"links": {
"self": "https://au-api.basiq.io/jobs/61723",
"source": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
}
```
Upon successful completion of all three steps, the job moves to the fetch stage to retrieve the data.
To ensure you receive the data once it's available, continue polling this jobs endpoint until you receive a success status for all three steps. Once all steps are successfully completed, you can proceed to fetch the data.
## STEP 6: Fetch your aggregated data
Once you have successfully created a connection, you can go ahead and retrieve the data belonging to it. Letβs retrieve a list of all the accounts this user has connected through Basiq.
```javascript STEP 5: Fetch accounts
// STEP 5: Fetch your aggregated data
var axios = require('axios');
var config = {
method: 'get',
url: 'https://au-api.basiq.io/users/{user.id}/accounts',
headers: {
'Authorization': 'Bearer $YOUR_ACCESS_TOKEN',
'Accept': 'application/json'
}
};
axios(config)
.then(function (response) {
console.log(response.data);
})
.catch(function (error) {
console.log(error);
});
```
```curl
curl --location --request GET 'https://au-api.basiq.io/users/a920c00f-df79-4a12-b711-2ac461c8090b/accounts' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN' \
--header 'Accept: application/json'
```
The response will contain an array of Account objects, containing specific account details such as the account number, balance and available funds.
#### **Congratulations!** You have now created a user consent, connected a financial institution, and retrieved their financial data.
Β
Feel free to deep dive into our [full API reference](https://api.basiq.io/) to see what else is possible with Basiq.
π’ Attention! If you have any issues, please reach out to our amazing support team.