Skip to main content
To begin using the Turris API, follow these steps:

​
1. Create an Upstream Entity Account

If you don’t already have one, you’ll need to reach out to Turris support to invite you onto the Turris platform.
You will need two separate invitations - one for the sandbox environment and another one for the live production environment.
Contact support@turrisfi.com to request access.

​
2. Generate API Credentials

1

Log into the web app

Access your Turris dashboard at the appropriate environment URL.
2

Navigate to API Settings

Go to Settings > API in the navigation menu.
3

Create your credentials

Create your API credentials of choice. We highly recommend the OAuth flow.
4

Store credentials securely

Store the credentials before closing the modals.
Important: Sensitive secrets and tokens are not known to Turris, are stored as hashed strings, and cannot be retrieved again at a later time. If you lose them, you will have to delete the issued credentials and create new ones.

​
3. Environment Setup

Choose the appropriate environment for your use case:
Use CaseEnvironmentBase URL
Development & TestingSandboxhttps://public.api.sandbox.turrisfi.com
ProductionLivehttps://public.api.live.turrisfi.com

​
4. Make Your First API Call

Once you have your credentials, authenticate and make your first request: 
curl -X POST "https://public.api.sandbox.turrisfi.com/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "your-client-id",
    "clientSecret": "your-client-secret"
  }'

​
Next Steps

Authentication

Learn about OAuth and Restricted Access Token authentication

Entity Definitions

Understand the core entities and their relationships

API Reference

Explore all available endpoints

Error Handling

Learn how to handle API errors