API docs by Redocly

Supercede API V2

Download OpenAPI specification:

Support: support@supercede.com

Introduction

Welcome to the Supercede API reference. This API lets you to programmatically access the Supercede platform.

With the API, you can do things like create layers, publish deals, and market those deals to lists of underwriters on the platform.

Access

Supercede uses API keys to allow access to the API. Access is currently only granted to select organisations. If you do not have an API key and you believe you should, please contact support.

Pagination

Some endpoints are paginated, meaning they do not return the full list of responses on the first request. To query for the next page, copy the contents of the response header Next-Range into the request header Range. If there is no Next-Range header in the response, that means the response contained the final page.

Terminology

To ensure API stability, resources may have a different name in the API than they do in the Supercede web UI. In particular, "risk" and "deal" both refer to what is known as "placement" in the Supercede web UI.

Changelog

The following is a reverse chronological list of changes made to this API since it was first published. The API is evolving through the principle of backwards compatibility, meaning endpoints may be added, and response objects may have fields added to them.

If we need to perform backwards incompatible changes, such as removing fields from response objects, or adding mandatory fields to request objects, both old and new schemata will be supported during a deprecation period, to allow clients time to be updated. Backwards-incompatible changes may be performed with a shorter deprecation period if we are able to verify that no customer relies on that functionality. Such changes will be listed here for reference.

2026-07-08

  • Added optional sliding_scale_commission_calculation_type fields to Deal layer object schema. This affects /layers, /layers-v2, /layers/{layer_id}, /risks/{deal_id}/pricing-features, /risks/{deal_id}/pricing-features/{company_id}/{stamp_name}/{layer_id} and /risks/{deal_id}/pricing-features/{company_id}/{stamp_name}/{layer_id}.

2026-07-06

  • Added new endpoint /layers/{layer_id}/coverage, where coverage can have multiple amounts in different currencies.

2026-06-25

  • Added optional territorial_scope and perils fields to layer coverage schema. This affects /layers, /layers-v2 and /layers/{layer_id} endpoints.
  • Added optional layer_aggregate_limits, facultative_limits and industry_loss_warranty fields to layer coverage schema. This affects /layers, /layers-v2, /layers/{layer_id} and /risks/historical endpoints.

2026-06-24

  • Added optional monetary field to layer brokerage object schema. This affects /layers, /layers-v2, /layers/{layer_id} and /risks/historical endpoints.
  • Added reinsurance_premium and reinsurance_premium_description fields to layer rate object schema. The custom_premium field is removed and rate.reinsurance_premium + rate.reinsurance_premium_description fields are intended to be used instead. This affects /layers, /layers-v2, /layers/{layer_id} and /risks/historical endpoints.

2026-06-22

  • Added optional fronting_capacity field to /risks/{risk_id}/accounting schemas.

2026-06-19

  • Added optional premium_income.data.percentage_us, sections.subsections.premium_percentage_us and sections.subsections.total_insured_value fields to /risks and /risks/{risk_id} schemas.

2026-06-17

  • Added optional subject_premium_percentage_us, total_insured_value, coverages.estimated_premium_income and coverages.total_insured_value fields. This affects /layers-v2 and /layers/{layer_id} endpoints.

2026-06-12

  • Added coverages.surplus_line, coverages.peril_coverages.surplus_line and product_data.data.surplus_line fields. This affects /layers, /layers-v2 and /layers/{layer_id} endpoints.

2026-06-10

  • Added lors_code to accounting information.

2026-06-09

  • Added description field to layer.

2026-05-28

  • Added loss_ratio_cap field to proportional pricing features. This affects /risks/{deal_id}/pricing-features (GET) and /risks/{deal_id}/pricing-features/{company_id}/{stamp_name}/{layer_id} (PUT).

2026-05-22

  • Added trigger_type and payout_basis fields to loss warranty. This affects /layers, /layers-v2 and /layers/{layer_id}.

2025-12-30

  • Added signing_date field to lines. This affects GET /lines. This new field records the date(s) when the reinsurer added their signature to the final reinsurance contracts.

2025-12-17

  • Added optional boolean is_not_taken_up query parameter to GET /risks.

2025-12-08

  • Added brokerage field to pricing features. This affects /risks/{deal_id}/pricing-features and /risks/{deal_id}/pricing-features/{company_id}/{stamp_name}/{layer_id}. This new brokerage field consists of both monetary brokerage, which may have 1 amount per currency, and brokerage as a percentage, for which a single amount and basis may be specified.

2025-11-14

  • Added industry_loss_warranty to layer data.

2025-11-10

  • Added /risks/{deal_id}/documents endpoint.

2025-11-07

  • Removed deprecated collateral field from layer data.

2025-11-03

  • Added layer_aggregate_limits to layer data.

2025-10-30

  • Added not_taken_up_reason field to layer and deal data.

2025-10-24

  • Made the limit field optional in limit-and-excess and loss warranty data.
  • Made the percent_limit field optional in percent limit-and-excess data.

2025-09-29

  • Added endpoint /risks/{risk_id}/last-changed.

2025-09-18

  • Added /layers-v2 endpoint. The difference in the new version is that the status field indicates the stage of the layer (draft, quoting, retracted, fot, bound), and there is a new field is_archived containing the information held in the status field of the old /layers endpoint.

2025-06-18

  • Deprecated fields brokerage_rebate and collateral. Users of these fields should use accounting market information instead.

2025-06-04

  • Added market_info field to deal accounting data.
  • Added accounting_market_info field to historical risk endpoint.

2025-05-23

  • Added layer_reporting_requirements field to deal accounting data.

2025-05-20

  • Added premium_basis field to deal subsection data.

2025-05-19

  • Added premium_payment_warranty to deal accounting data.

2025-05-15

  • Added cash_layer_loss_limit field to deal accounting data.

2025-05-06

  • Added new premium basis values: GEP, NEP, and AFP.

2025-03-31

  • Added perils field to layer and coverage data.

2025-03-27

  • Added territorial_scope field to layer and coverage data.

2025-03-21

  • Added subject_premium_basis field to layer data.

2025-02-11

  • Increased detail in custom premium data.

2025-02-04

  • Removed comment field from quote endpoints.

2024-11-15

  • Added endpoints for managing subjectivities, comments, and pricing features.

2024-10-19

  • Added endpoint /risks/{risk_id}/audit-trail.
  • Added endpoint /risks/historical to backfill with historical risks.

2024-05-13

  • Added layer_original_acquisition_cost to risk accounting data.

2024-05-09

  • Added fot, archived, and bound risk statuses.

2024-04-25

  • Replaced in_market with fot, both as a field and a filter.

2023-11-24

  • Added field duplicates to the risk object, containing risk duplicate information. Limited duplicates visibility to users with the Client role.
  • Added brokerage_splits to the risk accounting object.

2023-11-21

  • Added cover_note_status mandatory field to risk objects.
  • Added cover_note_status as a filter to the risk listing endpoint.

2023-11-06

  • The risk_options/{risk_option_id}/brokerage_rebate endpoint was removed. This functionality has been moved to risks/{risk_id}/accounting

2023-10-31

  • Fields internal_expenses, premium_payment_schedule, cedent_participations, internal_reference were removed. This information has been moved to a new Risk Accounting endpoint and is available only to risk cedent users at the FOT/Bound stages.
  • Field target_premium was renamed to target_reinsurance_premium.
  • Field max_recoverable was removed.

2023-10-13

  • When creating new risks, the following fields have been removed and are no longer accepted: id and cedent_participations.
  • The type of loss_additional_premium was changed to number.

2023-10-10

  • It is now prohibited to specify line_of_business_id for new layers, this information instead being derived from the subline of business.

2023-09-29

  • The /territories endpoint was added.
  • The /perils endpoint was added.
  • The geography field was replaced with an optional territorial_scope field, which holds two territory codes. This applies to the top-level risk data, subsection data within a risk, and layers.
  • The cession_basis field was added to layer data.
  • Non-proportional layers have new possible values of product: industry_loss_warranty and clash_excess_of_loss.
  • Values of brokerage_basis were changed.
  • The fields annual_aggregate_deductible, annual_aggregate_limit, and occurrence_limit were removed from proportional product data.
  • Non-proportional product data had the following optional fields added: loss_warranties, agg_percent_limits, per_risk_percent_limits, occurrence_agg_percent_limits, and facultative_limits.
  • The type of some optional fields in non-proportional product data was changed from a plain number to a limit object with two fields. This affects agg_limits, catastrophe_agg_limits, clash_agg_limits, occurrence_agg_limits, and per_risk_limits.
  • The premium_payment_schedule field was changed to a list of premium payment schedule objects.
  • A required perils field was added to layer subsection data.
  • An optional field internal_expenses was added to layer data.
  • An optional field peril_coverages was added to coverage data.

Catalogue

Get all non-broker organisations on the platform

This operation gets all organisations registered with the platform that are either cedents or underwriters.

header Parameters
Authorization
required
string
Example: Bearer shavbhx.b8bf849fab9b7526088554bdc91d2cb77f381d70

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get all geographic regions recognised by the platform

This operation shows all geographic regions as they are defined on the platform.

header Parameters
Authorization
required
string
Example: Bearer crgmgih.8f645bc4dfe4f9286c69d513a5a221f50dec389a

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get all lines of business recognised by the platform

This operation shows all lines of business as they are defined on the platform.

header Parameters
Authorization
required
string
Example: Bearer vyvgbow.9c313c442db0f25c58ca4722141df0002123574c

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get all sublines of business available to your organisation

This operation shows all sublines of business available to your organisation.

query Parameters
lob_id
string
Example: lob_id=Property

Limit listing to the sublines under this parent line of business.

header Parameters
Authorization
required
string
Example: Bearer gkvbqet.350df5592035ada77d2f694ef9b8eaa1ed81ed74

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get all perils recognised by the platform

This operation shows all perils as they are defined on the platform.

header Parameters
Authorization
required
string
Example: Bearer ulhssxe.22b539bc39b7dee2a58a86d91614bc1c5ec08347

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get all territories recognised by the platform

This operation shows all territories which can be used in deal definitions.

header Parameters
Authorization
required
string
Example: Bearer nwwlhbl.4fdccce744b049c7ce9a4803321f395a154e506f

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Entities

Get the name of a company

This operation returns the name of the company with the given company_id.

path Parameters
company_id
required
string <uuid>
Example: 0f315430-660c-d475-58d2-e8803f7b13f2

The ID of the company for which the name is desired.

header Parameters
Authorization
required
string
Example: Bearer eqftvtm.3aec4673ed8f48dd1ec6d5c471c6c0865de52bd1

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get information about a stamp.

Retrieve more information about a stamp on the Supercede platform, such as mappings to OpenTWINS. (TK examples for lors and opentwins)

path Parameters
stamp_name
required
string (Stamp name)
Example: NEXANS%20RE%20SA

The URL encoded name of the stamp for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer ofudsbm.4ccf43477f4006cb72cdb9aa56dc56b8361fc7b9

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get information about a user

This operation returns email and company details about the user with the given user_id.

path Parameters
user_id
required
string <uuid>
Example: 499abb44-0843-6def-5daa-9f0e91de827c

The ID of the user for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer jzsqgcl.fb387f233394dfa6268b8adb637654abfb93944e

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Search users matching criteria

This operation returns the user objects that match the given criteria.

query Parameters
email
required
string <email>
Example: email=fatima@prismrisk.co.uk

The email of the user that you want to find. This must match exactly for a result to be returned.

header Parameters
Authorization
required
string
Example: Bearer mloxavi.769bb1603490747eabd256fdadc2595311649ded

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Deals

Discover all accessible deals.

List the deals you have access to.

query Parameters
year
integer <int64> (Deal year)
Example: year=2025
status
string
Enum: "archived" "locked" "draft" "quoting" "retracted" "fot" "in_market" "bound"
Example: status=draft
cover_note_status
string (Cover note status)
Enum: "submitted" "pending"
Example: cover_note_status=pending
is_not_taken_up
boolean (Deal hasn't been taken up)
Example: is_not_taken_up=true
header Parameters
Authorization
required
string
Example: Bearer gzsuich.0f1a7fd905da844d2d8bfc9b3d79fb2a044464b0

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Create a new deal.

Create a new draft deal.

header Parameters
Authorization
required
string
Example: Bearer gzsuich.0f1a7fd905da844d2d8bfc9b3d79fb2a044464b0

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
class_of_business
required
string (Class of business)
Enum: "treaty" "facultative" "retrocession"

Class of business

clients
Array of strings
contract_reference
string (Contract reference)

A reference to the contract corresponding to this deal.

description
string

A description of this deal.

required
Continuous deal (object) or Bounded deal (object)
inception
required
string <date-time> (Inception date)

Inception date

original_insured
string (Original insured for a facultative deal.)
object (Deal Premium Income)

The specification of premium income for a deal.

Array of objects (Program level feature)
program_name
required
string

The name of this deal.

Array of objects (Section)
object (Territorial scope)

Contains lists of included and excluded territories.

Responses

Request samples

Content type
application/json
{
  • "class_of_business": "treaty",
  • "clients": [
    ],
  • "contract_reference": "FTR-9900-23/C",
  • "description": "TransContinental Re's maximum participation in the European tornado program shall be limited to 18% of the whole, with net catastrophe exposure of $87m and program aggregate deductible of $15m.",
  • "expiration": {
    },
  • "inception": "2024-06-01T00:00:00Z",
  • "original_insured": null,
  • "premium_income": {
    },
  • "program_level_features": [
    ],
  • "program_name": "Retro Japan",
  • "sections": [
    ],
  • "territorial_scope": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get information about a deal.

Get information about a deal.

path Parameters
deal_id
required
string <uuid>
Example: 35991787-41d5-b24b-4023-c51cd43e29a7

The ID of the deal to get information from

header Parameters
Authorization
required
string
Example: Bearer wkgkhrf.fd95b8d136d8bff8ea0850440c293ecc3a47d370

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Deals > Audit Trail

Get a timestamp for when this deal was last changed.

This corresponds to the timestamp of the most recent event in the audit trail for the deal.

path Parameters
deal_id
required
string <uuid>
Example: 6a9eb56c-2e48-c1ff-b699-0b1fc2231b36

The ID of the deal to get the last changed timestamp for.

header Parameters
Authorization
required
string
Example: Bearer fjhkmlz.74ed8c1d0c33b02de7d07c05ca4591bbbceadd65

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Get the audit trail for a deal.

Retrieves all audit trail events associated with the specified deal.

path Parameters
deal_id
required
string <uuid>
Example: f2b8e8fa-435b-0d44-43b4-86d9be9b017f

The ID of the deal to get the audit trail for.

query Parameters
latestTimestamp
boolean
Example: latestTimestamp=false

This parameter is deprecated. Use the /api/risks/{deal_id}/last-change API endpoint instead.

header Parameters
Authorization
required
string
Example: Bearer nekpwtx.4b11113b2f2c6ac44891066c673750f3ab562a82

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Deals > Accounting

Get deal accounting information.

path Parameters
deal_id
required
string <uuid>
Example: 5c036184-89a3-5a1f-a34b-e1fbd5a9a566

The ID of the deal to which the pricing features are applied

header Parameters
Authorization
required
string
Example: Bearer jdguknq.1daeb0d336bf0d4d3e26b402a46c38a860f60b51

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Put deal accounting information.

It should be noted that a complete rewrite of accounting information occurs, and not a partial one. Therefore, if any information was not specified, then this information is taken as null.

path Parameters
deal_id
required
string <uuid>
Example: 69c4b822-195e-29b8-b474-32f0210235ae

The ID of the deal to which the pricing features are applied

header Parameters
Authorization
required
string
Example: Bearer jdguknq.1daeb0d336bf0d4d3e26b402a46c38a860f60b51

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
Array of objects (Brokerage split)
Array of objects (Layer cash loss limits)
Array of objects (Cedent participations in a specific layer)
Array of objects (Layer internal expenses)
Array of objects (Layer internal reference)
Array of objects (Layer max recoverable)
Array of objects (Layer original acqusition cost)
Array of Proportional layer reporting requirements data (object) or Non-Proportional layer reporting requirements data (object)
Array of objects (Accounting market information)
Array of objects (Premium payment)
premium_payment_warranty
integer <int64> (Integer value)

Premium payment warranty value. Must be in range from 0 to 999 if present.

Responses

Request samples

Content type
application/json
{
  • "brokerage_splits": [
    ],
  • "layer_cash_loss_limit": [
    ],
  • "layer_cedent_participations": [
    ],
  • "layer_internal_expenses": [
    ],
  • "layer_internal_references": [
    ],
  • "layer_max_recoverables": [
    ],
  • "layer_original_acquisition_costs": [
    ],
  • "layer_reporting_requirements": [
    ],
  • "market_info": [
    ],
  • "premium_payment_schedule": [
    ],
  • "premium_payment_warranty": 721
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Deals > Documents

Discover all accessible documents uploaded to a Deal.

List the documents you have access to.

path Parameters
deal_id
required
string <uuid>
Example: 65a57c48-9395-12ed-c7f8-a35e5ac4193f

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer qhaiufj.eba8ae89fdc4af7781660ed5f6591291fcd67c23

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{}

Deals > Historical

Create historical deal.

Create a historical bounded deal.

header Parameters
Authorization
required
string
Example: Bearer mfvqqfh.539b5d1da4c63732767fc6c21798edf3ab3f0c4f

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
required
Array of objects (Accounting market information)
brokerage_rebate
number [ 0 .. 100 ]

Deprecated brokerage rebate value (ignored).

required
Array of objects (Brokerage split)
class_of_business
required
string (Class of business)
Enum: "treaty" "facultative" "retrocession"

Class of business

clients
required
Array of strings <uuid> [ items <uuid > ]
contract_reference
string

Contract reference identifier.

description
required
string

Description of the deal.

required
Continuous deal (object) or Bounded deal (object)
inception
required
string <date-time>

Deal inception date and time.

required
Array of objects (Historic deal layer)
original_insured
string

Name of the original insured party.

required
object (Deal Premium Income)

The specification of premium income for a deal.

Array of objects (Premium payment)
required
Array of objects (Program level feature)
program_name
required
string

Name of the deal.

required
Array of objects (Section)
object (Territorial scope)

Contains lists of included and excluded territories.

Responses

Request samples

Content type
application/json
{
  • "accounting_market_info": [
    ],
  • "brokerage_rebate": 2.5,
  • "brokerage_splits": [
    ],
  • "class_of_business": "facultative",
  • "clients": [
    ],
  • "contract_reference": "KNP-2023-456-TRX",
  • "description": "We offer new facultative cover for the Riverside Industrial Complex in Bangkok, with a max recovery of $75m for Evergreen Manufacturing, which operates facilities in Thailand and Malaysia.",
  • "expiration": {
    },
  • "inception": "2025-01-01T00:00:00Z",
  • "layers": [
    ],
  • "original_insured": null,
  • "premium_income": {
    },
  • "premium_payment_schedule": [
    ],
  • "program_level_features": [
    ],
  • "program_name": "London Market Quota Share",
  • "sections": [
    ],
  • "territorial_scope": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Deals > Layers

Get all deal layers (deprecated).

Returns a list of deal layers available to the user.This endpoint is deprecated, please use GET /layers-v2 instead.

query Parameters
risk_id
string <uuid>
Example: risk_id=06d79fd8-9696-2508-f3dc-6f98f76adb6b

Returns only layers for the deal with the specified ID.

status
string
Enum: "archived" "locked" "draft" "quoting" "retracted" "fot" "in_market" "bound"
Example: status=draft

Returns only layers for deals with the given status. Note that "in_market" is deprecated and will be removed in the next API version; please use fot instead.

year
integer <int64>
Example: year=2021

Returns only layers for deals with the specified inception/expiration year.

risk_inception
string <date>
Example: risk_inception=2018-01-01

Returns only layers for deals with the specified inception date.

risk_expiration
string <date>
Example: risk_expiration=2018-12-31

Returns only layers for deals with the specified expiration date.

header Parameters
Authorization
required
string
Example: Bearer qlifezx.bc160a7f3f9ea02d644f1de40abe82f5a7022bad

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Range
string
Example: id 1874e1ed-755f-49d9-a525-9b0e00bff4c1;limit 10;offset 1;order asc

Control the range of results in server's response. Header value consists of the following semicolon-separated fields: - is the name of the unit to paginate by, typically "id". - the value of the first element should have. limit - how many elements to include in the response. offset - starting from the , how many elements to skip before starting to include elements, typically 1. order [asc/desc] - control the way results are sorted.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Create deal layer.

This operation creates a deal layer based on the data provided.

header Parameters
Authorization
required
string
Example: Bearer qlifezx.bc160a7f3f9ea02d644f1de40abe82f5a7022bad

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
object (Layer brokerage)
contract_reference_override
string

A reference of the contract.

Array of objects (Create layer coverage data)
description
string

Layer description.

Array of objects (Deal layer Lloyds code)
name
required
string

Deal layer name

object (Deal layer order)
product
required
string
Enum: "aggregate_excess_of_loss" "catastrophe_excess_of_loss" "clash_excess_of_loss" "excess_of_loss_ratio" "facultative_excess_of_loss" "facultative_obligatory" "industry_loss_warranty" "quota_share" "risk_excess_of_loss" "surplus"

Deal layer product (contract type).

required
Proportional layer product data (object) or Non-Proportional layer product data (object)
object (Layer rate)
reinsurance_period
string
Enum: "yoa_period" "lod_period" "pid_period" "rad_period"

Deal layer reinsurance period.

risk_id
required
string <uuid>

Supercede-internal ID of the deal.

object (Layer income)
subject_premium_basis
string
Enum: "gwp" "nwp" "gnwp" "gnep" "gnpi" "gnepi" "gep" "nep" "afp"

Deal layer subject premium basis.

subject_premium_percentage_us
number (Percentage) [ 0 .. 100 ]

US premium percentage.

Array of objects (Money)
object (Territorial scope)

Contains lists of included and excluded territories.

object (Total insured value data)

Compatible with Facultative deals only

Responses

Request samples

Content type
application/json
{
  • "brokerage": {
    },
  • "contract_reference_override": "CV75RSB0824",
  • "coverages": [
    ],
  • "description": "Layer description",
  • "lloyds_codes": [
    ],
  • "name": "Space transportation of selenium",
  • "order": {
    },
  • "product": "risk_excess_of_loss",
  • "product_data": {
    },
  • "rate": {
    },
  • "reinsurance_period": "lod_period",
  • "risk_id": "0ef65949-0ce8-4912-b9bf-1511d7aeaa7b",
  • "subject_income": {
    },
  • "subject_premium_basis": "gnpi",
  • "subject_premium_percentage_us": 0,
  • "target_reinsurance_premium": [
    ],
  • "territorial_scope": {
    },
  • "total_insured_value": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get all deal layers.

Returns a list of deal layers available to the user.

query Parameters
risk_id
string <uuid>
Example: risk_id=65a57c48-9395-12ed-c7f8-a35e5ac4193f

Returns only layers for the deal with the specified ID.

status
string
Enum: "archived" "locked" "draft" "quoting" "retracted" "fot" "in_market" "bound"
Example: status=archived

Returns only layers for deals with the given status. Note that "in_market" is deprecated and will be removed in the next API version; please use fot instead.

year
integer <int64>
Example: year=2021

Returns only layers for deals with the specified inception/expiration year.

risk_inception
string <date>
Example: risk_inception=2018-01-01

Returns only layers for deals with the specified inception date.

risk_expiration
string <date>
Example: risk_expiration=2018-12-31

Returns only layers for deals with the specified expiration date.

header Parameters
Authorization
required
string
Example: Bearer tmnjack.02657ee77bc0ee28049bef3cce083272ca670f98

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Range
string
Example: id 24311c2d-8965-4bb5-be8d-1232dd273037;limit 10;offset 1;order asc

Control the range of results in server's response. Header value consists of the following semicolon-separated fields: - is the name of the unit to paginate by, typically "id". - the value of the first element should have. limit - how many elements to include in the response. offset - starting from the , how many elements to skip before starting to include elements, typically 1. order [asc/desc] - control the way results are sorted.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Get the details of a specific deal layer.

This operation returns a deal layer given by layer_id.

path Parameters
layer_id
required
string <uuid>
Example: f2b8e8fa-435b-0d44-43b4-86d9be9b017f

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer tpagopw.c38891d223bb2ac262c016df698b76f95eda6dfc

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Deal > Layer > Coverage

Get coverage information for the specified layer.

path Parameters
layer_id
required
string <uuid>
Example: 5d33c0b2-af25-400a-88bf-95ebf006577a

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer epktacg.bae5de639d920942da0e759ecfa1438777d2b716

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Create or update layer coverage details.

path Parameters
layer_id
required
string <uuid>
Example: 4f576647-0058-226e-a240-be5024ff2cd8

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer epktacg.bae5de639d920942da0e759ecfa1438777d2b716

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
Array
Array of objects (Limits)
Array of objects (Limits)
object (Estimated premium income data)

Compatible with Treaty and Retrocession deals only

Array of objects (Limits)
Array of objects (Loss warranty)
Array of objects (Limits)
notes
string

Notes on the layer coverage.

Array of objects (Limits)
Array of objects (Limits)
Array of objects (Peril coverage)
object (Peril scope)

Contains lists of included and excluded perils.

subline_of_business_id
required
string

The subline to which the coverage is applied.

Array of objects (Surplus line)
object (Territorial scope)

Contains lists of included and excluded territories.

object (Total insured value data)

Compatible with Facultative deals only

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Deals > Quotes

Discover all quotes on a deal layer.

This operation returns all quotes of the deal layer given by layer_id.

query Parameters
layer_id
required
string <uuid>
Example: layer_id=06d79fd8-9696-2508-f3dc-6f98f76adb6b

The ID of the deal layer for which the quoptes are desired.

header Parameters
Authorization
required
string
Example: Bearer pslewoh.d6ead4ebf3d299caf9f2f19718d104afbd5f249c

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Create a quote for a deal layer.

This operation creates a quote on a deal layer based on the data provided.

header Parameters
Authorization
required
string
Example: Bearer pslewoh.d6ead4ebf3d299caf9f2f19718d104afbd5f249c

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
ceding_commission
number [ 0 .. 100 ]

Ceding commission percentage value.

expiry_date
string <date>

Quote expiry date.

layer_id
required
string <uuid>

A uuid representing the Supercede-internal ID of the layer for which the quote is provided.

line_size
number [ 0 .. 100 ]

Line size percentage value.

name
required
string

Quote name.

object (Money)

Reinsurance premium amount.

rate_on_line
number [ 0 .. 100 ]

Quote rate-on-line percentage value.

rate_on_premium
number [ 0 .. 100 ]

Quote rate percentage value.

reference
string

Internal underwriter quote reference.

stamp_name
required
string

Underwriting company stamp name.

Responses

Request samples

Content type
application/json
{
  • "ceding_commission": 92.39236000290737,
  • "expiry_date": "1881-09-08",
  • "layer_id": "6f2dbb90-14af-4d67-8919-668668f9d0ad",
  • "line_size": 89.64702276860231,
  • "name": "Mid-level quote",
  • "premium": {
    },
  • "rate_on_line": 59.0053847707632,
  • "rate_on_premium": 70.16918819589517,
  • "reference": "aviation_qt_m01",
  • "stamp_name": "ALLIANZ RE DUBLIN LTD"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Retract a deal from Quoting or FOT stage

path Parameters
deal_id
required
string <uuid>
Example: 65a57c48-9395-12ed-c7f8-a35e5ac4193f

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer rekgfbm.4e51922978b842755bbdddbfd842c1c07db50f57

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "success": true
}

Move a draft deal to the quoting stage.

path Parameters
deal_id
required
string <uuid>
Example: 35991787-41d5-b24b-4023-c51cd43e29a7

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer iscxlpu.879e2e9877472c110f038c1d0be48828ce95ddef

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "success": true
}

Deals > Lines

Get the lines of a deal layer

This operation returns all lines of the deal layer given by layer_id.

query Parameters
layer_id
required
string <uuid>
Example: layer_id=2ee34d81-dabd-0994-a1ea-060c245f28d3

The ID of the deal layer for which the lines are desired.

header Parameters
Authorization
required
string
Example: Bearer xuqozyq.23840f56783ad9e5618fea44e25d5ca6a899ecfb

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}

Deals > Market list

Set the market list for a deal.

This operation allows you to overwrite the market list for the deal given by risk_id.

query Parameters
risk_id
required
string <uuid>
Example: risk_id=3579da6a-81cd-e19c-7daa-dc70528ef9c0

The ID of the deal for which this market list should apply.

header Parameters
Authorization
required
string
Example: Bearer krnynzk.e84e57d609e0aa16472540846d2716e0146dd1ee

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
Array
company_id
required
string <uuid>

An uuid representing the Supercede-internal ID of the company.

required
Array of objects (Deal layer)
required
Array of objects (User)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "error": {
    },
  • "success": false
}

Deals > Subjectivities

Get all comments on a deal.

Returns a list of all comments attached to a deal.

path Parameters
deal_id
required
string <uuid>
Example: a6a21d92-eefa-c975-45b9-cecdc7661fda

The ID of the deal for which comments are requested.

header Parameters
Authorization
required
string
Example: Bearer rmoansm.4b7b2cf98b7a3f6c71bfbd8124fe08cc7b34e631

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Add comments on a deal.

Allows comments to be added to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 4f7fa093-eea9-e7b6-8790-ab7e2a41aa46

The ID of the deal to which comments should be added.

header Parameters
Authorization
required
string
Example: Bearer rmoansm.4b7b2cf98b7a3f6c71bfbd8124fe08cc7b34e631

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
required
Array of objects (Comment)

Responses

Request samples

Content type
application/json
{
  • "comments": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Edit a comment on a deal.

Allows for submitting new comment data that should replace the existing data.

path Parameters
deal_id
required
string <uuid>
Example: 65a57c48-9395-12ed-c7f8-a35e5ac4193f

The ID of the deal on which this comment is made.

comment_id
required
string <uuid>
Example: 69c4b822-195e-29b8-b474-32f0210235ae

The ID of the comment to be updated.

header Parameters
Authorization
required
string
Example: Bearer dhqysof.e317fdd6aa3410ac44c14e525cea8edb1ffcd7bb

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
company_id
string <uuid>

An UUID representing the Supercede-internal ID of the company that created the comment. Shall not be included when creating comments as an underwriter.

content
required
string

The content of this comment.

layer_ids
required
Array of strings <uuid> (Layer ID) [ items <uuid > ]
stamps
required
Array of strings (Stamp)

Responses

Request samples

Content type
application/json
{
  • "company_id": "f56add31-79ca-4cf6-9c24-a0de08f52013",
  • "content": "No, that was not what we decided last we met.",
  • "layer_ids": [
    ],
  • "stamps": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Delete a comment from a deal.

Allows for removing a comment from a deal.

path Parameters
deal_id
required
string <uuid>
Example: 3579da6a-81cd-e19c-7daa-dc70528ef9c0

The ID of the deal on which this comment is made.

comment_id
required
string <uuid>
Example: b4538396-8f33-8d9c-de90-db7fe017f69f

The ID of the comment to be deleted.

header Parameters
Authorization
required
string
Example: Bearer dhqysof.e317fdd6aa3410ac44c14e525cea8edb1ffcd7bb

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "error": {
    },
  • "success": false
}

Get deal pricing features.

This operation returns all available pricing fratures of the deal given by deal_id.

path Parameters
deal_id
required
string <uuid>
Example: 69c4b822-195e-29b8-b474-32f0210235ae

The ID of the deal to which the pricing features are applied.

header Parameters
Authorization
required
string
Example: Bearer qjpvqpf.b682e2cdb1c6b8d3be5c6eae1d0f918914fbabee

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Create or update pricing features for a specific stamp and layer.

This operation creates new or updates existing pricing fratures given by company_id, stamp_name and layer_id.

path Parameters
risk_id
required
string <uuid>
Example: 06d79fd8-9696-2508-f3dc-6f98f76adb6b

The ID of the deal to which the pricing features are applied.

company_id
required
string <uuid>
Example: 06d79fd8-9696-2508-f3dc-6f98f76adb6b

The ID of the company to which the pricing features are applied.

stamp_name
required
string <non-empty string> .+
Example: Stamp_title_ABC

The stamp title to which the pricing features are applied.

layer_id
required
string <uuid>
Example: 3579da6a-81cd-e19c-7daa-dc70528ef9c0

The ID of the layer to which the pricing features are applied.

header Parameters
Authorization
required
string
Example: Bearer kbtscjv.195e0c6e9844b1077a9ad4ada1314cd5b8c35848

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
One of
required
object (Proportional layer pricing features data)

An object carrying pricing features data for the proportional layer.

tag
required
string

This is always "pricing_features_prop_api" value.

Responses

Request samples

Content type
application/json
Example
{
  • "contents": {
    },
  • "tag": "pricing_features_prop_api"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Delete pricing features for a specific stamp and layer.

This operation deletes pricing fratures given by company_id, stamp_name and layer_id.

path Parameters
risk_id
required
string <uuid>
Example: 860789aa-1934-d9e4-55f3-59b806a44f11

The ID of the deal from which the pricing features need to be removed.

company_id
required
string <uuid>
Example: e7510cb7-5e8e-fd6d-9847-fd681e671b39

The ID of the company from which the pricing features need to be removed.

stamp_name
required
string <non-empty string> .+
Example: Stamp_title_ABC

The stamp title from which the pricing features need to be removed.

layer_id
required
string <uuid>
Example: b4538396-8f33-8d9c-de90-db7fe017f69f

The ID of the layer from which the pricing features need to be removed.

header Parameters
Authorization
required
string
Example: Bearer kbtscjv.195e0c6e9844b1077a9ad4ada1314cd5b8c35848

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "error": {
    },
  • "success": false
}

Get all subjectivities on a deal.

Returns a list of all subjectivities attached to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 5d33c0b2-af25-400a-88bf-95ebf006577a

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer dsumfsb.37fc2def14a9ca376c6082b7fdb541098cb1295b

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Add subjectivities for review.

Allows subjectivities to be added to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 197c3e02-9b4b-2b39-bf1c-14d81824098b

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer dsumfsb.37fc2def14a9ca376c6082b7fdb541098cb1295b

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
required
Array of objects (Subjectivity)

Responses

Request samples

Content type
application/json
{
  • "subjectivities": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Edit subjectivity content.

Set the content of a subjectivity to something new.

path Parameters
deal_id
required
string <uuid>
Example: 2ee34d81-dabd-0994-a1ea-060c245f28d3

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 860789aa-1934-d9e4-55f3-59b806a44f11

The ID of the subjectivity to be edited.

header Parameters
Authorization
required
string
Example: Bearer dhomlfb.f53c8cb5a8d1b385d78fce03a5eb41ca64f28c98

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Request Body schema: application/json
content
required
string

The content that should replace the current content of this subjectivity.

Responses

Request samples

Content type
application/json
{
  • "content": "We would like to exclude the territory of Svalbard from this layer."
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Accept subjectivity for deal.

Transitions a pending subjectivity into the accepted state.

path Parameters
deal_id
required
string <uuid>
Example: f2b8e8fa-435b-0d44-43b4-86d9be9b017f

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 2ee34d81-dabd-0994-a1ea-060c245f28d3

The ID of the subjectivity to be accepted.

header Parameters
Authorization
required
string
Example: Bearer yqpecmv.3c972f214aacaadcf74a9ce5b35d9269ff148d9b

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Reject subjectivity for deal.

Transitions a pending subjectivity into the rejected state.

path Parameters
deal_id
required
string <uuid>
Example: 65a57c48-9395-12ed-c7f8-a35e5ac4193f

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: c36dd2a6-c39f-3e68-c886-f2d4c4609e73

The ID of the subjectivity to be rejected.

header Parameters
Authorization
required
string
Example: Bearer skfqkzi.ae3c03b40222147807e9bf905b56dd407a0b72f3

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Retract subjectivity for deal.

Transitions a pending subjectivity into the retracted state.

path Parameters
deal_id
required
string <uuid>
Example: b4538396-8f33-8d9c-de90-db7fe017f69f

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 4f7fa093-eea9-e7b6-8790-ab7e2a41aa46

The ID of the subjectivity to be retracted.

header Parameters
Authorization
required
string
Example: Bearer pjazbmb.a6bb041afbffa7c6a8ca44694848858de90f081b

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Supercede-Version
required
string
Example: 2020-10-01

A version indicator required on some endpoints for disambiguation. The value should always be 2020-10-01 in those cases.

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "success": true
}

Testing > Echo

Test the API connectivity.

Call this endpoint with valid JSON in the request body to see if the API responds back with a non-failure status code.

header Parameters
Authorization
required
string
Example: Bearer xrktphe.4c339c4cd657815cb1474c8587e429f4e6675683

Bearer-based HTTP authentication. The value should be "Bearer" followed by your API key.

Request Body schema: application/json
message
string

An example key–value pair in an object.

Responses

Request samples

Content type
application/json
{
  • "message": "An example key-value pair in an object."
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}