Skip to main content

​
Turris Public API

The Turris workspace features two API collections:
CollectionDescription
Authentication APIExposes all authentication flows
Upstream Entity APIFor 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

Invite Agencies

Invite agencies to onboard with your organization

Add Agencies

Add agencies directly if you have all the onboarding information

List Associations

Find all the agencies associated with your organization

Retrieve Documents

Retrieve any document associated with your organization

E&O/Cyber Compliance

Manage E&O/Cyber compliance for all associated agencies

License Compliance

Retrieve current license compliance status for agencies and agents

How to Get Started

Step-by-step guide to begin using the API

Authentication

Learn about OAuth and Restricted Access Tokens

Entity Definitions

Understand core entities and their relationships

Environments

Sandbox vs Production environments