> ## Documentation Index
> Fetch the complete documentation index at: https://docs.turrisfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Turris Public API documentation

# Turris Public API

The Turris workspace features two API collections:

| Collection              | Description                         |
| ----------------------- | ----------------------------------- |
| **Authentication API**  | Exposes all authentication flows    |
| **Upstream Entity API** | For MGAs, Carriers, and Wholesalers |

## Authentication API

This collection exposes all relevant authentication endpoints needed to get authenticated. We strongly recommend following the secure OAuth flow which exchanges your `clientId` and `clientSecret` for a signed JWT which in turn grants you access to almost all endpoints if attached as a bearer token to your requests.

Alternatively, if you cannot follow the OAuth flow (e.g., your app does not have a native API which is required for making requests to the OAuth Get Token endpoint), you can use a **Restricted Access Token**. All protected endpoints support both authentication methods interchangeably.

## Upstream Entity API

This collection exposes all relevant endpoints that allow an upstream entity (MGA, Carrier, or Wholesaler) to:

* **CRUD on resources** - such as retrieving all associated downstream entities
* **Request core workflows** - such as getting the compliance status of a downstream entity or agent

The Upstream Entity API is a powerful interface that allows our upstream customers to programmatically interact with the Turris platform. This API enables customers to manage agencies, agents, products, policies, and retrieve compliance status for agency licenses and E\&O/Cyber policies in an automated and efficient manner.

By leveraging this API, customers can integrate Turris workflows directly into their own systems and workflows, streamlining operations and enhancing productivity.

## Use Cases

<CardGroup cols={2}>
  <Card title="Invite Agencies" icon="envelope">
    Invite agencies to onboard with your organization
  </Card>

  <Card title="Add Agencies" icon="building">
    Add agencies directly if you have all the onboarding information
  </Card>

  <Card title="List Associations" icon="list">
    Find all the agencies associated with your organization
  </Card>

  <Card title="Retrieve Documents" icon="file">
    Retrieve any document associated with your organization
  </Card>

  <Card title="E&O/Cyber Compliance" icon="shield-check">
    Manage E\&O/Cyber compliance for all associated agencies
  </Card>

  <Card title="License Compliance" icon="id-card">
    Retrieve current license compliance status for agencies and agents
  </Card>
</CardGroup>

## Quick Links

<CardGroup cols={2}>
  <Card title="How to Get Started" icon="rocket" href="/guides/getting-started">
    Step-by-step guide to begin using the API
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn about OAuth and Restricted Access Tokens
  </Card>

  <Card title="Entity Definitions" icon="sitemap" href="/guides/entity-definitions">
    Understand core entities and their relationships
  </Card>

  <Card title="Environments" icon="server" href="/guides/environments">
    Sandbox vs Production environments
  </Card>
</CardGroup>