Generate an auth token

❗️

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.

Prerequisites

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

1. Sign-up to the Basiq API service
2. Grab an API key for your application (via the Developer Dashboard)

Steps to authenticate

Pass the API key in the Authorization header and Basiq API version you intend to use, as well as the scope of access you need. The server will validate the key and if everything is successful will issue an access token.

👍

Token scopes

The scope of a CLIENT_ACCESS token is restricted and should be used when making any calls directly from the client side.

A SERVER_ACCESS token can be used for all endpoints and has full access to create resources and retrieve data. Never expose a server access token on your client side!

🚧

CLIENT_ACCESS tokens must be bound to a userId

Any token generated with a CLIENT_ACCESS scope must be bound to a userId

You will get this userId by calling Create a user Endpoint.