NAV

Introduction

Welcome! The Basiq API gives you secure access to all the resources you need to successfully integrate your app with hundreds of financial institutions.

Our API strives to be as RESTful as sanely possible. It has has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. All resource data is represented as JSON objects.

Getting Started

Start Developing

Before you can start using the Basiq API there are a few things you will need to do first.

  1. Sign-up to the Basiq API service
  2. Register your application via the developer dashboard
  3. Generate an api key for your application

Now that you have successfully obtained your api key, you can start using the Basiq API.

Note that all of the resources (available via the Basiq API) are secured, and therefore require a valid access token to be included in the header of each request. You can obtain the access token once you have authenticated your app.

Authentication

DEFINITION

POST https://au-api.basiq.io/oauth2/token

EXAMPLE REQUEST

POST /token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW

grant_type=client_credentials

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
    "access_token":"2YotnFZFEjr1zCsicMWpAA",
    "token_type":"Bearer",
    "expires_in":3600
}

EXAMPLE ERROR RESPONSE

HTTP/1.1 400 Bad Request
Content-Type: application/json
Cache-Control: no-store

{
  "errors": [
    {
      "type": "error",
      "id": "1464360676",
      "code": "invalid_grant",
      "title": "Token Expired",
      "detail": "Access token has expired please authenticate.",
      "source": {
        "pointer": "/header/Authorization"
      },
      "links": {
        "about": "https://developer.basiq.io/apidocs/authentication"
      }
    }
  ]
}

When working with the Basiq API your application will need to authenticate itself first before it can access any of the available resources.

Once your application has successfully authenticated it will receive a generated token which will need to be sent with each API request.

Prerequisites

Prior to authenticating your application you will need to complete the following steps:

Steps to authenticate

  1. Call /oauth2/token passing in the api key in the header of the request
  2. The server will validate the key and if everything is successful will issue an access token.

This access token is the key to making successful requests to the Basiq API. From here on you will need to include this access token in the header when requesting any of the secured resources.

Calling Basiq API resources

To call Basiq API resources your application will need to include the supplied access token via the Authorization: Bearer [access_token] header.

Possible Errors

In the event that something goes wrong a valid HTTP status code and error object will be returned in the body of the response.

   
invalid_request The request is missing a required parameter, includes an unsupported parameter value (other than grant type) or is otherwise malformed.
Http 400 Bad Request
invalid_client Application authentication failed (e.g., unknown application, no authentication included, or unsupported authentication method).
Status 401 Unauthorized
invalid_grant The provided Authorization grant (e.g. apiKey) or token is invalid, expired or has been revoked.
Status 400 Bad Request
unauthorized_client The authenticated application is not authorized to use this Authorization grant type.
Status 400 Bad Request
unsupported_grant_type The Authorization grant type is not supported.
Status 400 Bad Request

Resources

The Basiq API provides five core resources that enable you to successfully integrate with institutions and extract users financial data.

Connections

EXAMPLE CONNECTION OBJECT

{
  "type": "connection",
  "id": "4",
  "externalUserId": "721832",
  "loginId": "gavin_belson",
  "password": "h00l33",
  "status": "active",
  "lastUsed": "2016-06-08T09:10:32.000Z",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4",
    "accounts": "https://au-api.basiq.io/connections/4/accounts",
    "transactions": "https://au-api.basiq.io/connections/4/transactions"
  }
}

The connection object represents user login details for a particular institution (typically loginId and password). These details are used to acquire authorized account and transaction data on behalf of the end-user.

The status property identifies the validity of the connection. Note that if the connection is not active the Connect API will not be able to supply up-to-date financial data.

Attributes  
type
string, read-only
Value is “connection”.
id
string, read-only
A string that uniquely identifies the user connection.
externalUserId
string, required
A identifier that uniquely identifies a user within your application.
loginId
string, required
User’s institution login ID. This value cannot be read.
password
string, required
User’s institution password. This value cannot be read.
securityCode
string, optional
User’s institution security code. This value cannot be read.
status
string, read-only
Indicates the connection status. Possible values include:
  • not-verified the connection has not been confirmed yet with the institution
  • active the connection is valid (is working!)
  • invalid the connection is no longer valid and requires the user to update their logon details
lastUsed
string, optional
UTC Date and Time of when the connection was last used to acquire users financial data.
institution
object, read-only
The institution the connection relates to.
links
object, read-only
A links object containing the following members:
  • self link to the requested connection
  • accounts link to the accounts associated with this connection
  • transaction link to the transactions associated with this connection

See institution object for list of required properties.

Create a connection

DEFINITION

POST https://au-api.basiq.io/connections

EXAMPLE REQUEST

POST /connections HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

{
  "loginId": "gavin_belson",
  "password": "h00l33",
  "externalUserId": "721832",    
  "institution":{
    "id":"AU00101"
  }
}

EXAMPLE RESPONSE

HTTP/1.1 201 Created
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "connection",
  "id": "4",
  "externalUserId": "721832",
  "status": "active",
  "lastUsed": "2016-06-08T09:10:32.000Z",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "accounts": {
    "type": "list",
    "data": [
      {
        "type": "account",
        "id:": "5",
        "accountNo": "600000157441965",
        "name": "Master Savings",
        "currency": "AUD",
        "accountType": "Bank",
        "balance": "356.50",
        "availableFunds": "420.28",
        "lastUpdated": "2016-06-08T09:10:32.000Z",
        "links": {
          "self": "https://au-api.basiq.io/connections/4/accounts/5",
          "transactions": "https://au-api.basiq.io/connections/4/transactions?filter[account.id]=5"
        }
      }
    ],
    "links": {
      "self": "https://au-api.basiq.io/connections/4/accounts"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4",
    "accounts": "https://au-api.basiq.io/connections/4/accounts",
    "transactions": "https://au-api.basiq.io/connections/4/transactions"
  }
}

Use this to add new user connection. Once the new connection has been created their status will be set to not-verified until the server has managed to successfully acquire the connection financial records.

If the server was successful the status will be set to active otherwise if the server was unable to acquire the data using the supplied connection details the status will be se to invalid.

Attributes  
loginId
string, required
The users institution login ID
password
string, required
The users institution password
securityCode
string, optional
User’s new institution security code.
externalUserId
string, required
A identifier that uniqely identifies a user within your application.
institution
object, required
Only the id of the institution is required

Returns

Returns a connection object if the request succeeded. The returned object will have links to the acquired account and transaction data. Note that if the server was unable to acquire the data immediately the links will still be returned.

Otherwise, this call returns an error.

Refresh a connection

DEFINITION

POST https://au-api.basiq.io/connections/4/refresh

EXAMPLE REQUEST

POST /connections/4/refresh HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 201 Created
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "connection",
  "id": "4",
  "externalUserId": "721832",
  "status": "active",
  "lastUsed": "2016-06-08T09:10:32.000Z",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "accounts": {
    "type": "list",
    "data": [
      {
        "type": "account",
        "id:": "5",
        "accountNo": "600000157441965",
        "name": "Master Savings",
        "currency": "AUD",
        "accountType": "Bank",
        "balance": "356.50",
        "availableFunds": "420.28",
        "lastUpdated": "2016-06-08T09:10:32.000Z",
        "links": {
          "self": "https://au-api.basiq.io/connections/4/accounts/5",
          "transactions": "https://au-api.basiq.io/connections/4/transactions?filter[account.id]=5"
        }
      }
    ],
    "links": {
      "self": "https://au-api.basiq.io/connections/4/accounts"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4",
    "accounts": "https://au-api.basiq.io/connections/4/accounts",
    "transactions": "https://au-api.basiq.io/connections/4/transactions"
  }
}

The server will periodically retrieve the users latest account and transaction details from the institution to ensure that the data is readily available. You can also force the server to fetch the latest data from the institution by calling this resource.

Returns

Returns a connection object if the request succeeded. The returned object will have links to the latest account and transaction data.

To ensure the user’s institution is not flooded with requests this resource is rate limited to 20 requests per 15 minute window / per connection. Once the rate limit has been reached the resource will return a HTTP 409 Too Many Requests with the following headers:

If the limit is exceeded you can always retrieve the last acquired data by calling the account or transaction resource.

Otherwise, this call returns an error.

Retrieve a connection

DEFINITION

GET https://au-api.basiq.io/connections/{connection.id}

EXAMPLE REQUEST

GET /connection/4 HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "connection",
  "id": "4",
  "externalUserId": "721832",  
  "status": "active",
  "lastUsed": "2016-06-08T09:10:32.000Z",  
  "institution":{
    "type":"institution",
    "id":"AU00101",
    "links":{
      "self":"https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4",
    "accounts": "https://au-api.basiq.io/connections/4/accounts",
    "transactions": "https://au-api.basiq.io/connections/4/transactions"
  }
}

Retrieves the details of an existing connection. Note that the loginId, password, securityCode are not returned with this request.

Returns

Returns a connection if a valid ID was provided. Returns an error otherwise.

Update a connection

DEFINITION

PUT https://au-api.basiq.io/connections/{connection.id}

EXAMPLE REQUEST

PUT /connection/4 HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

{
  "password": "Pied-Piper",
  "externalUserId": "721832"
}

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "connection",
  "id": "4",
  "externalUserId": "721832",  
  "status": "active",
  "institution":{
    "type":"institution",
    "id":"AU00101",
    "links":{
      "self":"https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4",
    "accounts": "https://au-api.basiq.io/connections/4/accounts",
    "transactions": "https://au-api.basiq.io/connections/4/transactions"
  }
}

Use this to update an existing connection. Once the updated connection have been received their status will be set to not-verified until the server has managed to successfully acquire the financial records.

If the server was successful the status will be set to active otherwise if the server was unable to acquire the data using the supplied connection details the status will be se to invalid.

Attributes  
id
string, required
The identifier of the connection to be updated.
loginId
string, optional
User’s new institution login ID.
password
string, optional
User’s new institution password.
securityCode
string, optional
User’s new institution security code.
externalUserId
string, optional
A identifier that uniqely identifies a user within your application.

Returns

Returns a connection object if the request succeeded. The returned object will have links to the acquired account and transaction data.

Otherwise, this call returns an error.

Delete a connection

DEFINITION

DELETE https://au-api.basiq.io/connections/{connection.id}

EXAMPLE REQUEST

DELETE /connection/4 HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 204 No Content

Deletes a connection along with their associated accounts and transactions.

Returns

No content is returned on successful deletion.

In the event that something goes wrong an error will be returned.

Accounts

EXAMPLE ACCOUNT OBJECT

{
  "type": "account",
  "id": "5",
  "accountNo": "600000-157441965",
  "name": "Master Savings",
  "currency": "AUD",
  "accountType": "bank",
  "balance": "$356.50",
  "availableFunds": "$420.28",
  "lastUpdated": "2016-06-02T09:20:10.000Z",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "connection": {
    "type": "connection",
    "id": "4",
    "links": {
      "self": "https://au-api.basiq.io/connections/4"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4/accounts/5",
    "transactions": "https://au-api.basiq.io/connections/4/transactions?filter[account.id]=5"
  }
}

This is an object representing a users financial institution account. You can use this object to observe current balances and verify account numbers. there are 4 types of accounts: bank, credit-card, loan, investment.

Attributes  
type
string, read-only
Value is “account”.
id
string, read-only
A string that uniquely identifies the account.
accountNo
string, read-only
Full account number.
name
string, read-only
Institution (or user) defined account name.
currency
stringv
Identifies the currency the funds are stored in using ISO 4217 standard.
accountType
string, read-only
An enum identifying the account type: bank, credit-card, loan or investment.
balance
string, read-only
How much money is in the account right now excluding any pending transactions.
availableFunds
string, read-only
Funds that are available to an account holder for withdrawal or other use. This may include funds from an overdraft facility or line of credit, as well as funds classified as the available balance, such as from cleared and existing deposits. See http://www.investopedia.com/terms/a/available-funds.asp
lastUpdated
string, read-only
UTC Date and Time of when account balance and funds were last updated.
institution
object, read-only
The institution the account is held at.
connection
object, read-only
The connection used to acquire account details.
links
string, read-only
A links object containing the following members:
  • self link to the requested account
  • transactions link to the transactions belonging to this account

Retrieve an account

DEFINITION

GET https://au-api.basiq.io/connections/{connection.id}/accounts/{account.id}

EXAMPLE REQUEST

GET /connection/4/accounts/5 HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "account",
  "id": "5",
  "accountNo": "600000-157441965",
  "name": "Master Savings",
  "currency": "AUD",
  "accountType": "bank",
  "balance": "$356.50",
  "availableFunds": "$420.28",
  "lastUpdated": "2016-06-02T09:20:10.000Z",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "connection": {
    "type": "connection",
    "id": "4",
    "links": {
      "self": "https://au-api.basiq.io/connections/4"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4/accounts/5",
    "transactions": "https://au-api.basiq.io/connections/4/transactions?filter[account.id]=5"
  }
}

Retrieves the details of the account.

Returns

Returns an account object.

List all accounts

DEFINITION

GET https://au-api.basiq.io/connections/{connection.id}/accounts

EXAMPLE REQUEST

GET /connection/4/accounts HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "list",
  "data": [
    {
      "type": "account",
      "id": "5",
      "links": {
        "self": "https://au-api.basiq.io/connections/4/accounts/5"
      }
    },
    {
      "type": "account",
      "id": "6",
      "links": {
        "self": "https://au-api.basiq.io/connections/4/accounts/6"
      }
    }
  ],
  "links": {
    "self": "https://au-api.basiq.io/connections/4/accounts"
  }
}

Returns a list of accounts.

Returns

A dictionary with a data property that contains an array of accounts. Each entry in the array is a separate account object.

Transactions

EXAMPLE TRANSACTION OBJECT

{
  "type": "transaction",
  "id": "789",
  "status": "posted",
  "description": "ADOBE  CREATIVE CLOUD    800-833-6687IRL",
  "postDate": "2016-01-01",
  "transactionDate": null,
  "amount": "-$139.98",
  "balance": "$356.50",
  "bankCategory": "INCOME",
  "transactionType": "online-payment",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "connection": {
    "type": "connection",
    "id": "4",
    "links": {
      "self": "https://au-api.basiq.io/connections/4"
    }
  },
  "account": {
    "type": "account",
    "id": "5",
    "links": {
      "self": "https://au-api.basiq.io/connections/4/accounts/5"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4/transactions/789"
  }
}

This is an object representing a users (account) transaction. You can use this object to observe individual transactions. Transactions also come with a transactionType property which classifiers the transaction, see complete list of possible transaction type values.

Notes:

Attributes  
type
string, read-only
Value is “transaction”.
id
string, read-only
A string that uniquely identifies the transaction.
status
string, read-only
An enum identifying the status of the transaction: pending or posted. Pending Transactions are authorized or submitted items that have not yet​ posted to your account. Note that pending transactions will be removed once their posted counterparts appear.
description
string, read-only
Transaction description (supplied by institution).
postDate
string, read-only
The UTC date when a card issuer processes a credit/debit card transaction and adds it to the cardholder’s account balance. See http://www.investopedia.com/terms/c/credit-card-posting.asp
transactionDate
string, read-only
The UTC date and time of when the transaction took place. See http://www.investopedia.com/terms/t/transaction-date.asp.

This value is not always available and may sometimes include time value as well.
amount
string, read-only
Transaction amount. Negative values denote money spent. Positive values denote deposits.
balance
string, read-only
The account balance at time of transaction.
bankCategory
string, read-only
Bank category of transaction.
transactionType
string, read-only
Transaction type code. See transaction type for list of all possible values.
institution
object, read-only
The institution that handled the transaction.
connection
object, read-only
The connection used to acquire the transaction data.
account
object, read-only
The account the transaction belongs to.
links
string, read-only
A links object containing the following members:
  • self a link to the requested resource

Retrieve a transaction

DEFINITION

GET https://au-api.basiq.io/connections/{connection.id}/transactions/{transaction.id}

EXAMPLE REQUEST

GET /connection/4/transactions/789 HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "transaction",
  "id": "789",
  "status": "posted",
  "description": "ADOBE  CREATIVE CLOUD    800-833-6687IRL",
  "postDate": "2016-01-01",
  "transactionDate": null,
  "amount": "-$139.98",
  "balance": "$356.50",
  "bankCategory": "INCOME",
  "transactionType": "online-payment",
  "institution": {
    "type": "institution",
    "id": "AU00101",
    "links": {
      "self": "https://au-api.basiq.io/institutions/AU00101"
    }
  },
  "connection": {
    "type": "connection",
    "id": "4",
    "links": {
      "self": "https://au-api.basiq.io/connections/4"
    }
  },
  "account": {
    "type": "account",
    "id": "5",
    "links": {
      "self": "https://au-api.basiq.io/connections/4/accounts/5"
    }
  },
  "links": {
    "self": "https://au-api.basiq.io/connections/4/transactions/789"
  }
}

Retrieves the details of the transaction.

Returns

Returns a transaction object.

List all transactions

DEFINITION

GET https://au-api.basiq.io/connections/{connection.id}/transactions

EXAMPLE REQUEST

GET /connection/4/transactions HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "list",
  "totalCount": 982,
  "data": [
    {
      "type": "transaction",
      "id": "789",
      "status": "posted",
      "description": "ADOBE  CREATIVE CLOUD    800-833-6687IRL",
      "postDate": "2016-01-01",
      "transactionDate": null,
      "amount": "-$139.98",
      "balance": "$356.50",
      "bankCategory": "INCOME",
      "transactionType": "online-payment",
      "institution": {
        "type": "institution",
        "id": "AU00101",
        "links": {
          "self": "https://au-api.basiq.io/institutions/AU00101"
        }
      },
      "connection": {
        "type": "connection",
        "id": "4",
        "links": {
          "self": "https://au-api.basiq.io/connections/4"
        }
      },
      "account": {
        "type": "account",
        "id": "5",
        "links": {
          "self": "https://au-api.basiq.io/connections/4/accounts/5"
        }
      },
      "links": {
        "self": "https://au-api.basiq.io/connections/4/transactions/789"
      }
    }
    {

    }
  ],
  "links": {
    "self": "https://au-api.basiq.io/connections/4/transactions?offset=4",
    "next": "https://au-api.basiq.io/connections/4/transactions?offset=9"    
  }
}

Returns a list of transactions. Default sort is by postedDate desc.

Query Parameters  
from-date
string, optional
Request transactions from date
to-date
string, optional
Request transactions to date

Returns

A dictionary with a data property that contains an array of transactions. Each entry in the array is a separate transaction object.

Institutions

EXAMPLE INSTITUTION OBJECT

{
  "type": "institution",
  "id": "AU00101",
  "name": "Citizens Bank of Angola",
  "shortName": "CBA",
  "institutionType": "Bank",
  "country": "AUS",
  "serviceName": "e-banking",
  "serviceType": "personal-banking",
  "logo": "https://au-api.basiq.io/institutions/T01001/logo",  
  "loginIdCaption": "AccessID",
  "passwordCaption": "Password",
  "securityCodeCaption": "",
  "links": {
    "self": "https://au-api.basiq.io/institutions/AU00101"
  }
}

This object represents a list of financial institutions supported by the Connect API. You can use this object to query the list of supported institutions when on-boarding new users along with properties that help render the connection form.

Attributes  
id
string, read-only
Unique identifier for the institution.
name
string, read-only
Name of institution.
shortName
string, read-only
Short name of institution.
institutionType
string, read-only
An enum identifying the institution type: bank, building-society, credit-union, financial-services.
country
string, read-only
Institution country code (ISO 3166-1 alpha-3 format).
serviceName
string, read-only
Name of the supported service (as defined by the institution).
serviceType
string, read-only
An enum the identifies the service type: personal-banking, business-banking, share-trading, card-access.
logo
string, read-only
URL of institution logo image, returned in PNG format.
loginIdCaption
string, read-only
Caption used by institution to request login id.
passwordCaption
string, read-only
Caption used by institution to request password.
securityCodeCaption
string, read-only
Caption used by institution to request security code.
links
object, read-only
A links object containing the following members:
  • self a link to the requested resource

Retrieve a institution

DEFINITION

GET https://au-api.basiq.io/institutions/AU00101

EXAMPLE REQUEST

GET /institutions/AU00101 HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "institution",
  "id": "AU00101",
  "name": "Citizens Bank of Angola",
  "shortName": "CBA",
  "institutionType": "Bank",
  "country": "AUS",
  "serviceName": "e-banking",
  "serviceType": "personal-banking",
  "loginIdCaption": "AccessID",
  "passwordCaption": "Password",
  "securityCodeCaption": "Password",
  "logo": "https://au-api.basiq.io/institutions/AU01001/logo",
  "links": {
    "self": "https://au-api.basiq.io/institutions/AU00101"
  }
}

Retrieves the details of the institution.

Returns

Returns a institution object.

List all institutions

DEFINITION

GET https://au-api.basiq.io/institutions

EXAMPLE REQUEST

GET /institutions HTTP/1.1
Accept: application/json
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW

EXAMPLE RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache, no-store

{
  "type": "list",
  "totalCount": 3,
  "data": [
    {
      "type": "institution",
      "id": "AU00101",
      "name": "Citizens Bank of Angola",
      "shortName": "CBA",
      "logo": {
        "type": "image",
          "links": {
            "self": "https://connect.basiq.io/institutions/AU00101/logo"
          }
      },
      "links": {
        "self": "https://au-api.basiq.io/institutions/AU00101"
      }
    },
    {
      "type": "institution",
      "id": "AU00102",
      "name": "Australia Bank",
      "shortName": "AB",
      "logo": {
        "type": "image",
          "links": {
            "self": "https://connect.basiq.io/institutions/AU00101/logo"
          }
      },
      "links": {
        "self": "https://au-api.basiq.io/institutions/AU00102"
      }
    },
    {
      "type": "institution",
      "id": "AU00103",
      "name": "Society Bank",
      "shortName": "SB",
      "logo": {
        "type": "image",
          "links": {
            "self": "https://connect.basiq.io/institutions/AU00101/logo"
          }
      },
      "links": {
        "self": "https://au-api.basiq.io/institutions/AU00103"
      }
    },
  ],
  "links": {
    "self": "https://au-api.basiq.io/institutions?offset=1",
    "first": "https://au-api.basiq.io/institutions?offset=1",
    "prev": null,
    "next": "https://au-api.basiq.io/institutions?offset=2",
    "last": "https://au-api.basiq.io/institutions?offset=2"
  }
}

Returns a list of institutions. Default sort is by name.

Returns

A dictionary with a data property that contains an array of institutions. Each entry in the array is a separate institution object.

Reference

Errors

EXAMPLE ERROR OBJECT

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "errors": [
    {
      "type": "error",
      "id": "1464360678",
      "code": "missing-property",
      "title": "Missing Attribute",
      "detail": "The loginId property is missing.",
      "source": {
        "pointer": "/connection/loginId"
      },
      "links": {
        "about": "https://developer.basiq.io/apidocs/errors"
      }
    },
    {
      "type": "error",
      "id": "1464360679",
      "code": "invalid-attribute",
      "title": "Invalid institution code",
      "detail": "The institution code you supplied is not recognisable.",
      "source": {
        "pointer": "/connection/institution/id"
      },
      "links": {
        "about": "https://developer.basiq.io/apidocs/errors"
      }
    }
  ]
}

The Connect API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with the Connect API’s servers (these are rare).

In addition to returning an appropriate HTTP code the body will also include a JSON formatted error object that provides more details about the specifics of the error. The error object will return the error as an array to indicate multiple errors (where present). For a complete list of codes, see error codes.

Attributes  
id
string, read-only
a unique identifier for this particular occurrence of the problem.
code
string, read-only
an application-specific error code, expressed as a string value.
title
string, read-only
a short, human-readable summary of the problem.
detail
string, read-only
a human-readable explanation specific to this occurrence of the problem.
source
object, read-only
an object containing references to the source of the error, optionally including any of the following members:
  • pointer the location to the object or attribute that the error relates to
  • parameter a string indicating which URI query parameter caused the error.
links
object, read-only
a links object containing the following members:
  • about a link that leads to further details about this particular occurrence of the problem.

Institution type

Institution are classified into the following types:

Possible Values  
bank Provide a description here.
credit-union Provide a description here.
building-society Provide a description here.
cedit-card Provide a description here.
prepaid-card Provide a description here.

Service type

Service types identifies the service supported by the institution.

Possible Values  
personal-banking Provide a description here.
business-banking Provide a description here.
share-trading Provide a description here.
card-access Provide a description here.