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-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 fkxhlro.cd8460097d634537ed60e92c65a1b965bf42a126

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 zoniekd.b744e006ca25e154fa36771d8fb6a0bc260e4653

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 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 ssmciwg.6bf40ed0f2080860e3ec511798786a70217f863e

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

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

header Parameters
Authorization
required
string
Example: Bearer rykqquh.9c6cfabe5170f631786ad051ea1d8dedd650ed3f

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 zggdmqi.dc02df1adcd83ce5350ee695aed0999bd2267e03

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 dolkbxe.b071346c0e54c77e56e4691a727c1176fb08ad5c

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: 34136d0a-ec6c-9839-64d2-0163e3050351

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

header Parameters
Authorization
required
string
Example: Bearer otkdhex.dd0993dd2d09ea25612be88b505869b464a42b29

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: ALLIANZ%20RE%20DUBLIN%20LTD

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

header Parameters
Authorization
required
string
Example: Bearer qvgepwo.48d64df5e2c6725b393a77cfec447ca01218cf4e

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: 19ec690b-0f58-bac4-5fd8-87c7e90b01a9

The ID of the user for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer njmxwlr.b4f5126e8a233e5f045cff08290aeeaa69fdf3dc

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=marcin@quartzassurance.com

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 xxtqoel.38e30a9dd5d8182b4df6d256f4ab851b17383fc5

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=bound
cover_note_status
string (Cover note status)
Enum: "submitted" "pending"
Example: cover_note_status=submitted
header Parameters
Authorization
required
string
Example: Bearer ighmldz.4250c7cbd119b4946aceea2da0a926da9cdd04d6

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 new deal.

Create a new draft deal.

header Parameters
Authorization
required
string
Example: Bearer ighmldz.4250c7cbd119b4946aceea2da0a926da9cdd04d6

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

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": "We invite participation in our Pacific typhoon excess program with a 15% brokerage split between MarshMac (50%) and Willis (50%), featuring a maximum recovery limit of $120m.",
  • "expiration": {
    },
  • "inception": "2024-06-01T00:00:00Z",
  • "original_insured": "Zenith Jewels",
  • "premium_income": {
    },
  • "program_level_features": [
    ],
  • "program_name": "Casualty 2025 limit",
  • "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: 79219f74-6a46-caf6-3fc5-c1cf92fc920b

The ID of the deal to get information from

header Parameters
Authorization
required
string
Example: Bearer jlqgwnk.c38eb793021508eae74ed77c3f17d242aae59b91

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 > 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: 348859a9-f5e9-8164-7fd9-168a3a094615

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

header Parameters
Authorization
required
string
Example: Bearer syolgtg.231ce297b5a17762e1dcc1d1e8dbacb488f6505d

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: 729733ea-ef2e-7181-0243-0444442203d8

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

query Parameters
latestTimestamp
boolean
Example: latestTimestamp=true

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

header Parameters
Authorization
required
string
Example: Bearer glyvspo.6fadeff00050c562e31b49209124316a4de9ac4e

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: 6717aa84-b623-5455-91b8-b98bde9a43f8

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

header Parameters
Authorization
required
string
Example: Bearer ebmreyf.09f3212f42e77f4e34fd15a36258b925253893b8

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

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: 6717aa84-b623-5455-91b8-b98bde9a43f8

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

header Parameters
Authorization
required
string
Example: Bearer ebmreyf.09f3212f42e77f4e34fd15a36258b925253893b8

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

Discover all accessible documents uploaded to a Deal.

List the documents you have access to.

header Parameters
Authorization
required
string
Example: Bearer lvhrwwd.1a342006641052c8dcc61690785e47d85e64be3f

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=99da7715-7710-ed58-ecbe-008e6ce64a5c

Returns only layers for the deal with the specified ID.

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

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 autywsz.cff22548be773c46da9e2343e9adf0cd4f47594e

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

Range
string
Example: id 8d6c7f3a-ad70-4492-9e39-090fee42a90d;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 autywsz.cff22548be773c46da9e2343e9adf0cd4f47594e

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

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": "surplus",
  • "product_data": {
    },
  • "rate": {
    },
  • "reinsurance_period": "rad_period",
  • "risk_id": "f5d087cc-d6e0-4094-ac45-93bbb49c8080",
  • "subject_income": {
    },
  • "subject_premium_basis": "afp",
  • "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=071f0e26-05c7-763c-7c7b-ea5880d6ea92

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 ykknbcm.2bf4728da61c5810a27b7c58df87b9774c2440b7

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

Range
string
Example: id 92e68a51-6789-422c-a3eb-072c92a81eab;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: ae549bc2-92e1-cb8a-e65a-6734583c9d64

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer pgonkxw.d6dec7013f7c90a8717b4837df096aa1a4075280

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=8b25d189-3644-ead9-907a-642d626f0531

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

header Parameters
Authorization
required
string
Example: Bearer hmppaly.9105178fde940564c76b8be0fcfe5f8469463a75

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 hmppaly.9105178fde940564c76b8be0fcfe5f8469463a75

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": 27.61068509255945,
  • "expiry_date": "1972-04-09",
  • "layer_id": "617e5b69-4bd8-4f9b-9820-c131fccb44e2",
  • "line_size": 83.03955828366055,
  • "name": "Very generous quote",
  • "premium": {
    },
  • "rate_on_line": 31.94471961748161,
  • "rate_on_premium": 34.803061747210236,
  • "reference": "aviation_qt_m01",
  • "stamp_name": "NEXANS RE SA"
}

Response samples

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

Retract a deal from Quoting or FOT stage

header Parameters
Authorization
required
string
Example: Bearer kbjvtnj.f666600899119a060ce5a22cb4cdb3ab67f23d5e

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 xcyfspl.45c46454de34dbe560a656b54a271611750ec104

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=03db1a31-dea8-1cba-b443-1a8737b9a0c2

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

header Parameters
Authorization
required
string
Example: Bearer jvqkftj.fe6418623f3403bdad4eef2e9f2eab2099f9d688

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=317533a5-7725-0179-da0d-7d10a9ff8e09

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

header Parameters
Authorization
required
string
Example: Bearer rpmkpld.0dcab97faa86b662c650c52ca8532f659f0558dc

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: d6a9be8e-1627-9d9a-5059-6015c91053b4

The ID of the deal for which comments are requested.

header Parameters
Authorization
required
string
Example: Bearer yxsvygs.ff61aaa4ca00339078fda70b2539409fb43afbda

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: d6a9be8e-1627-9d9a-5059-6015c91053b4

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

header Parameters
Authorization
required
string
Example: Bearer yxsvygs.ff61aaa4ca00339078fda70b2539409fb43afbda

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: 09bad003-b6f1-2e63-5c8e-a1f5c227a02a

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

comment_id
required
string <uuid>
Example: 308986c5-200a-1d53-ca41-f815ee28ac13

The ID of the comment to be updated.

header Parameters
Authorization
required
string
Example: Bearer rgcyksu.bdb856a58737ebf8e98e67767b84f1b7b81aebab

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: 09bad003-b6f1-2e63-5c8e-a1f5c227a02a

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

comment_id
required
string <uuid>
Example: 308986c5-200a-1d53-ca41-f815ee28ac13

The ID of the comment to be deleted.

header Parameters
Authorization
required
string
Example: Bearer rgcyksu.bdb856a58737ebf8e98e67767b84f1b7b81aebab

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: 5d4b8a29-f847-4f84-15c9-91a6a03ce32a

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

header Parameters
Authorization
required
string
Example: Bearer oltmjmr.1f76566439155c13cdb5db28f4193e7c2bd7798e

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: b30b2273-c11e-a8ad-5289-5d9835cb6994

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

company_id
required
string <uuid>
Example: 35a353dd-c7f4-8a30-eced-c8c7c96a1896

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: 4f510a09-d7a5-ffaa-7c54-d0510366750d

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

header Parameters
Authorization
required
string
Example: Bearer obmlvjs.17095972fddc132e457412667b20f528915077d5

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

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: b30b2273-c11e-a8ad-5289-5d9835cb6994

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

company_id
required
string <uuid>
Example: 35a353dd-c7f4-8a30-eced-c8c7c96a1896

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: 4f510a09-d7a5-ffaa-7c54-d0510366750d

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

header Parameters
Authorization
required
string
Example: Bearer obmlvjs.17095972fddc132e457412667b20f528915077d5

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 all subjectivities on a deal.

Returns a list of all subjectivities attached to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 03f845b1-6571-7675-c26f-5de025ee3d82

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer cezxivo.74a27b2b004353768e81c34f989b6523eaedfc91

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 subjectivities for review.

Allows subjectivities to be added to a deal.

path Parameters
deal_id
required
string <uuid>
Example: 03f845b1-6571-7675-c26f-5de025ee3d82

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer cezxivo.74a27b2b004353768e81c34f989b6523eaedfc91

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

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: 170c7946-c7f1-17f3-bd1d-6d236e350f55

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: c02cef3c-779e-4d7e-6cbd-e1ae4b0dea39

The ID of the subjectivity to be edited.

header Parameters
Authorization
required
string
Example: Bearer zbjsczo.13bba8ea9f0e03ae4a1bb94021b34d2658cdde34

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

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: b673388d-cc36-eaba-ef4d-c3539bd4c44a

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: e0aa2903-bb51-03ba-a9c5-4a740d027e5f

The ID of the subjectivity to be accepted.

header Parameters
Authorization
required
string
Example: Bearer ugvribo.90f6e0a024db99dfd850662523488a96bcfc1d5f

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

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: df566115-066f-b040-d6bd-c3146db3bff3

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: ec53b38c-8ab7-7581-27f7-3ebfbb63139e

The ID of the subjectivity to be rejected.

header Parameters
Authorization
required
string
Example: Bearer dpljnbp.e85e579013ae0ddfcf0237cab39f7f8feb3c8d1e

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

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: fb393165-2aff-b37c-49fa-426a409bb685

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: b99c7038-0284-284c-8056-34f8ed1a16d8

The ID of the subjectivity to be retracted.

header Parameters
Authorization
required
string
Example: Bearer mqeawrk.3509d9515ab79e464ed67e58eeff16a48452fca7

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

Responses

Response samples

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

Testing > Echo

Test the API connectivity.

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

header Parameters
Authorization
required
string
Example: Bearer yghwlmh.c98bc2ab0df66a02b1d2ca5e6eb818a639a97146

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

Responses

Response samples

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