Quickstart

This guide walks you through making your first API request to the Turris Public API.

Prerequisites

Before you begin, you’ll need:

An active Turris account with API access enabled
API credentials (OAuth client or Restricted Access Token)

Don’t have credentials yet? Create them in your Turris Dashboard under Settings → API.

Step 1: Get Your Credentials

Option A: OAuth Credentials (Recommended)

Go to Settings → API in your Turris dashboard
Click Create API Client
Save your client_id and client_secret securely

Option B: Restricted Access Token

Go to Settings → API in your Turris dashboard
Click Create Restricted Access Token
Configure your allowed IP addresses
Save your token securely

Step 2: Authenticate

OAuth (Recommended)
Restricted Access Token

Exchange your credentials for a JWT token:

curl -X POST "https://public.api.live.turrisfi.com/v1/auth/jwt" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "your-client-id",
    "clientSecret": "your-client-secret"
  }'

Response:

{
  "statusCode": 201,
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIs..."
  },
  "timestamp": "2025-01-30T12:34:56.789Z"
}

Tokens expire after 60 minutes. Cache the token and refresh before expiry.

No exchange needed—use your token directly in the x-restricted-access-token header:

curl -X GET "https://public.api.live.turrisfi.com/v1/downstream-entity-associations" \
  -H "x-restricted-access-token: your-restricted-token"

Requests are validated against your configured IP allowlist.

Step 3: Make Your First Request

Retrieve your downstream entity associations:

curl -X GET "https://public.api.live.turrisfi.com/v1/downstream-entity-associations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Step 4: Explore the API

Now that you’re authenticated, explore what you can do:

List Agents

Retrieve all agents in your network

Check Compliance

Get E&O and Cyber compliance status

Upload Documents

Upload compliance documents programmatically

Monitor Licenses

Track license statuses and expiration dates

Getting Started

Guides

Quickstart

Quickstart

Prerequisites

Step 1: Get Your Credentials

Option A: OAuth Credentials (Recommended)

Option B: Restricted Access Token

Step 2: Authenticate

Step 3: Make Your First Request

Step 4: Explore the API

List Agents

Check Compliance

Upload Documents

Monitor Licenses

Next Steps

Getting Started

Guides

​Quickstart

​Prerequisites

​Step 1: Get Your Credentials

​Option A: OAuth Credentials (Recommended)

​Option B: Restricted Access Token

​Step 2: Authenticate

​Step 3: Make Your First Request

​Step 4: Explore the API

List Agents

Check Compliance

Upload Documents

Monitor Licenses

​Next Steps

Quickstart

Prerequisites

Step 1: Get Your Credentials

Option A: OAuth Credentials (Recommended)

Option B: Restricted Access Token

Step 2: Authenticate

Step 3: Make Your First Request

Step 4: Explore the API

Next Steps