To start your development journey, create your account on Console. You can then create applications, get API keys, view and choose products to integrate with, and set up your open banking integration successfully.
You can join Console by either using single-sign-on (using your Google or GitHub accounts), or with your email address and password. When you create your account, you're guided through our registration wizard.
Need any help?
If you're stuck anywhere during your integration process, or you have a question that needs answering, check out our Support hub for further information.
Now that you've created your Console account, you can create an application and get your API keys, which you need to use our APIs.
Create an application by following the instructions in the modal that opens when you first set up your Console account. Alternatively, you can select the CREATE APP + button from the top menu. When the modal opens, name your application. By default, Console will open in Sandbox environment, so this will be the application you create to test your integration in Sandbox.
client_id is a unique string that we use to identify you as a client. You need to set up your
client_id for the application you're creating. You can't change the
client_id string once it's been set up.
client-id has to be between 4 to 30 lowercase characters, including both letters and numbers. You can't use special characters in your
Say you choose
testclientid as your
client_id value. As you're in the sandbox environment, your complete sandbox
client_id will look like this:
sandbox-testclientid-XXXXXX. Your live
client_id is different, read more about your app's live client ID later on this page.
client_secret is a secret key used to authenticate your application. You'll need this value to make API calls later, so make sure you've stored the value safely. Your live
client_secret is different, read more about your app's live client secret later on this page.
Add your team members to your application right away. Alternatively, you can go to the Team Members button on the left-hand navigation panel and add new team members later when you're ready to share your TrueLayer application with them.
By default, when you create a new Console account, you'll be on our sandbox environment. In sandbox, you can test your integration without live bank accounts. While testing, keep in mind that the sandbox does not include a full bank simulation with consistent bank accounts. Sandbox is only intended to facilitate API testing.
Test with confidence
All of your account data and transactions are completely separate from the live environment, so you don't have to worry about messing up real payments!
When you feel confident in your integration, you can use the live environment by switching the toggle in the top-right of the menu.
Your sandbox environment has a separate
client_secret to the live environment. These values are used to create an
access_token, which you need to call our APIs. Your sandbox account
client_id will always have the prefix sandbox-. You can't add this prefix to a live account
client_id. Sandbox client credentials can't be used to create a live
access_token and a sandbox
access_token can't be used to call live API endpoints.
You can't access mock payments and account data that you created in the sandbox by using live APIs.
For example, if a payment is created in the sandbox, an attempt to GET the payment resource in the live environment returns a 404 response. Similarly, when you use the Data API to retrieve banking data within the sandbox environment, this data isn't be accessible from within the live environment.
You can use sandbox API endpoints to access information (payments, withdrawals, account data, and more) in sandbox. Sandbox API endpoints are very similar to live API endpoints but with different domains.
Updated 23 days ago
Follow the guides to try out Postman collections for our APIs: