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.

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.

2025-12-30

  • Added signing_date field to lines. This affects GET /api/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 /api/risks.

2025-12-08

  • Added brokerage field to pricing features. This affects /api/risks/{deal_id}/pricing-features and /api/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 /api/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 /api/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 /api/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 /api/risks/{risk_id}/audit-trail.
  • Added endpoint /api/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 /api/territories endpoint was added.
  • The /api/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 ynljbkw.c58bea7b7a40f7de592120dbdfc59db02de269fd

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 lnkmoju.14847319cee93a900cfe459e675f400f05baaf3b

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 rmitrli.f6012871cd6ffa6dfc722d0e080bc287e7213986

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=Agriculture

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

header Parameters
Authorization
required
string
Example: Bearer dhmgyss.393ec98f37c60a9d79ed1904d620d015e2a77285

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 aoioruc.8a8f3623dc852d79b3ef0ba3677c4268e7a31ac9

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 emxoeee.7ff6daeb884a8386b36467beafa220babf19cf37

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: 53078f2c-251a-cccd-5769-6b44a9c47f1f

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

header Parameters
Authorization
required
string
Example: Bearer aphazcz.a7fbdc6fbaa28ed71163b3c8f32b2477ed5af2e4

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 llrrqfy.862aa0960df87e43308b97b09ffcee7beee4bdea

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: 7bac19f5-2801-3e76-a634-216d8cfc4ab9

The ID of the user for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer dhghupf.ee6c9989cd0af6825c1cf6dfce42cfd7abb68d21

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=oscar@apexinsurance.net

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 xjdfoqv.b72f80e9d99860efa01160e0dd6b5e298be0b015

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=archived
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=false
header Parameters
Authorization
required
string
Example: Bearer nfjweem.045a92b365e33a087df63e78182927acbc8a8723

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 nfjweem.045a92b365e33a087df63e78182927acbc8a8723

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": "facultative",
  • "clients": [
    ],
  • "contract_reference": "FTR-9900-23/C",
  • "description": "For our earthquake program in Santiago, first party physical damage is covered up to EUR 5m, with a combined single limit of $25m over all property policies for California earthquake exposure.",
  • "expiration": {
    },
  • "inception": "2025-01-01T00:00:00Z",
  • "original_insured": null,
  • "premium_income": {
    },
  • "program_level_features": [
    ],
  • "program_name": "London Market Quota Share",
  • "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: 9ca0d79a-089a-d879-0cdd-f8031d776abc

The ID of the deal to get information from

header Parameters
Authorization
required
string
Example: Bearer ayiqaue.a381f1069202083d53033085e60eb085af4d0c07

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: c24cf99a-d655-d0f6-345e-7ef0fbce5a18

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

header Parameters
Authorization
required
string
Example: Bearer zlfbskj.f9fef77a1d4822bce923369d396ea46dec8a7b9e

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: dcde17da-7c88-ec71-1f99-8a537222e3a3

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 rzbvbtf.1bb46b2ea9cfb6f06fdfc0762cf000a4c6e4a0ac

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: f2ebb9ad-8e3d-3d18-fb63-397acbd5331c

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

header Parameters
Authorization
required
string
Example: Bearer lahtbrl.adf5ebe00a7d9a45e4906a457eb12fbe41a768c3

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: f2ebb9ad-8e3d-3d18-fb63-397acbd5331c

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

header Parameters
Authorization
required
string
Example: Bearer lahtbrl.adf5ebe00a7d9a45e4906a457eb12fbe41a768c3

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 > Documents

Discover all accessible documents uploaded to a Deal.

List the documents you have access to.

header Parameters
Authorization
required
string
Example: Bearer fivooeg.2a6a5c060f3414ccff87d4243fd95c409b6e5c0f

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

Responses

Response samples

Content type
application/json
{}

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=40ce5a3c-5034-30e0-d167-b7a6cde9a1b2

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 kdosbeh.6da41477acd909d6c0c89ebf3c08c25798791784

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 0c5c23a4-d5dc-40df-a8ad-fe96df9ef0dd;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 kdosbeh.6da41477acd909d6c0c89ebf3c08c25798791784

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 (Deal layer coverage)
object (Layer custom premium)
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.

object (Money)

A monetary value representing the target reinsurance premium.

object (Territorial scope)

Contains lists of included and excluded territories.

Responses

Request samples

Content type
application/json
{
  • "brokerage": {
    },
  • "contract_reference_override": "CV75RSB0824",
  • "coverages": [
    ],
  • "custom_premium": {
    },
  • "lloyds_codes": [
    ],
  • "name": "The collapse of space and time",
  • "order": {
    },
  • "product": "quota_share",
  • "product_data": {
    },
  • "rate": {
    },
  • "reinsurance_period": "rad_period",
  • "risk_id": "f3e210bb-34e2-4448-aad2-383e8ce65465",
  • "subject_income": {
    },
  • "subject_premium_basis": "gnwp",
  • "target_reinsurance_premium": {
    },
  • "territorial_scope": {
    }
}

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=04a48e79-ce81-d2c7-dbab-9c21800b5dd7

Returns only layers for the deal with the specified ID.

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

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 rcappcj.ee47fdd9e6eb37ad269b31116a06e0284640ff56

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

Range
string
Example: id 2c79d2df-6fd6-48e4-b16e-b2971c006678;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: 8c760c8c-26f7-e616-1c13-ccdca3246293

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer tuzjves.fcf9798cee3afe82d31c7947acb4c6ac458ff73c

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 > 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=99d37ab5-733d-cec9-2de5-a87da1d550e9

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

header Parameters
Authorization
required
string
Example: Bearer ecsgvhc.04fa8fb6ae0a97875d1a6e274954883d12ab65ee

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 ecsgvhc.04fa8fb6ae0a97875d1a6e274954883d12ab65ee

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": 42.12033376250825,
  • "expiry_date": "1866-02-07",
  • "layer_id": "66d0efd8-2e38-4e25-b799-aea259b69e3e",
  • "line_size": 93.27466772584779,
  • "name": "Mid-level quote",
  • "premium": {
    },
  • "rate_on_line": 34.35966814998406,
  • "rate_on_premium": 74.27686626613895,
  • "reference": "Nameless Quote",
  • "stamp_name": "ALLIANZ RE DUBLIN LTD"
}

Response samples

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

Retract a deal from Quoting or FOT stage

header Parameters
Authorization
required
string
Example: Bearer axcvfob.d4c85272f5128dcedcf58c80f4b45f2e7c53c5c0

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.

header Parameters
Authorization
required
string
Example: Bearer wdnklyy.90bdd6d969ed82d0e62cc6a846416c422077934e

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=6bfcba9a-a8ae-4131-3398-1ba6767deeaa

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

header Parameters
Authorization
required
string
Example: Bearer amhssww.ac571f98e6d54537c759f6bfe56ddf48bbe0c6ae

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=8a081ca1-da24-13a1-afb0-aae3da076542

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

header Parameters
Authorization
required
string
Example: Bearer eatqwra.da161973268bced887bc8b9bde5935dac1a3724b

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
{
  • "data": null,
  • "success": true
}

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: b85f862a-9e7f-2787-14f5-226be8e078b4

The ID of the deal for which comments are requested.

header Parameters
Authorization
required
string
Example: Bearer kmreumz.a301a9ae2a840b04fdaf567188e65eee26397ffe

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: b85f862a-9e7f-2787-14f5-226be8e078b4

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

header Parameters
Authorization
required
string
Example: Bearer kmreumz.a301a9ae2a840b04fdaf567188e65eee26397ffe

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: 801afe01-5e11-817c-b281-f87a76c3fc4b

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

comment_id
required
string <uuid>
Example: d9b85972-d652-f399-d251-8dd5ff88e4ce

The ID of the comment to be updated.

header Parameters
Authorization
required
string
Example: Bearer vzwjvsz.38bcfd029f6e80f874426a2e61f958f559dbd0f9

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

Responses

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: 801afe01-5e11-817c-b281-f87a76c3fc4b

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

comment_id
required
string <uuid>
Example: d9b85972-d652-f399-d251-8dd5ff88e4ce

The ID of the comment to be deleted.

header Parameters
Authorization
required
string
Example: Bearer vzwjvsz.38bcfd029f6e80f874426a2e61f958f559dbd0f9

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
}

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: a5cf4087-610b-6608-33fc-10b97ba8f0d6

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

header Parameters
Authorization
required
string
Example: Bearer thwtnwa.bb0b844a51924a83e02347c754163ba5b5460280

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: 908f327c-7225-7325-7768-486f81cf6df3

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

company_id
required
string <uuid>
Example: c87eecba-b673-a5e0-4b1b-79ac7cb580ad

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: 7a7cd702-9261-787f-dfe6-6b9b77ff65b2

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

header Parameters
Authorization
required
string
Example: Bearer flgwdat.3d42445775a1b294af2bf13a9a1b9bfe08dbe557

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_non_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: 908f327c-7225-7325-7768-486f81cf6df3

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

company_id
required
string <uuid>
Example: c87eecba-b673-a5e0-4b1b-79ac7cb580ad

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: 7a7cd702-9261-787f-dfe6-6b9b77ff65b2

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

header Parameters
Authorization
required
string
Example: Bearer flgwdat.3d42445775a1b294af2bf13a9a1b9bfe08dbe557

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": null,
  • "success": true
}

Get all subjectivities on a deal.

Returns a list of all subjectivities attached to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 0f8c8a6f-856a-313d-713e-a1c83cdf3a75

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer isymuty.4e4d1e77714636143d90a192c9e83987aea86767

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: 0f8c8a6f-856a-313d-713e-a1c83cdf3a75

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer isymuty.4e4d1e77714636143d90a192c9e83987aea86767

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: b15bbc46-8ccf-9fb6-d1b6-aefae11c29b0

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 944d25aa-9467-1338-76ff-481fc5f0209e

The ID of the subjectivity to be edited.

header Parameters
Authorization
required
string
Example: Bearer rfaoqml.c3fde0ac10dc5ead5f2a7440c7f823741122e95d

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: 0ef137ab-51ab-ba23-4610-ba2dbed62d03

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 4ed7edc5-7ee5-cbf4-ff94-f2f2097af0ad

The ID of the subjectivity to be accepted.

header Parameters
Authorization
required
string
Example: Bearer oquiuun.46869b0afceacbbc97a818ce6785d4405b74f1ec

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: a84c951b-d82b-9167-060f-9e0ae9b656c0

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: b9dd6aa9-a12d-f380-67e5-fa04dff106a7

The ID of the subjectivity to be rejected.

header Parameters
Authorization
required
string
Example: Bearer znjjfhw.ed0d7d53069746adfc80ca36afce09ff661f615b

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: b730f685-3de6-cf8c-10d0-472e5ab95289

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 51b69e5b-f204-bbea-c465-444cd64b438d

The ID of the subjectivity to be retracted.

header Parameters
Authorization
required
string
Example: Bearer etpfyun.6cf008458cc29eff370e36a023e817030628dd10

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 jxkdyrt.e4c36a0d8e1c271cfbf63deb11009461420acb8d

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
}