B

Basiq API Playground

Consent URL Recipe

Go to Homepage
1

Server Token

2

Create User

3

Client Token

4

Consent URL

1

Generate Server Access Token

Create a server access token using your API Key from the Basiq dashboard.

Inputs

Don't have an API Key?Get one from the Basiq Dashboard

cURL Command

bash
curl --request POST \
  --url https://au-api.basiq.io/token \
  --header 'Authorization: Basic {{API_KEY}}' \
  --header 'accept: application/json' \
  --header 'basiq-version: 3.0' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data scope=SERVER_ACCESS
2

Create User

Create a Basiq user using the server access token. Either email or mobile is required.

Inputs

cURL Command

bash
curl --request POST \
  --url https://au-api.basiq.io/users \
  --header 'accept: application/json' \
  --header 'authorization: Bearer {{serverAccessToken}}' \
  --header 'content-type: application/json' \
  --data '{}'
3

Generate User-Bound Client Token

Create a client access token bound to a specific user. The User ID is auto-filled from Step 2.

Inputs

cURL Command

bash
curl --request POST \
  --url https://au-api.basiq.io/token \
  --header 'Authorization: Basic {{API_KEY}}' \
  --header 'accept: application/json' \
  --header 'basiq-version: 3.0' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data scope=CLIENT_ACCESS \
  --data userId={{userId}}
4

Generate Consent URL

Configure the consent URL with optional action and institution parameters.

Inputs