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-09-11

  • Added optional layer_expense_caps field to the Risk Accounting object, carrying TPA, LAE, and other expense caps per layer. Each cap can be expressed as a percentage, as monetary amounts in one or more currencies, or both.

2026-09-10

  • Added optional programme_dua field to Deal object schema. This affects /risks and /risks/{risk_id} endpoints.

2026-09-02

  • Risk Accounting now accepts and returns multiple layer_internal_references values for one layer.
  • Historical deal load accepts an optional internal_references array on each layer. The existing internal_reference field remains supported.

2026-08-28

  • Added optional excess_type and percent_excess_type fields to excess data.This affects `/layers/{layer_id}/coverage endpoint.

2026-08-27

  • Added optional fet_exempt_info field to stamp object schema.

2026-08-24

  • Added optional basis field to risk layer and pricing features schemas. This affects /layers-v2, /layers/{layer_id}, /risks/{risk_id}/pricing-features endpoints.

2026-08-21

  • Added optional renewed_from field to Deal object schema. This affects /risks and /risks/{risk_id} endpoints.

2026-08-20

  • Removed order_estimated_premium_income, brokerage_estimated_premium_income, loss_ratio_cap_estimated_premium_income and no_claim_bonus_estimated_premium_income fields from layer data.
  • Added adjustable_rate_estimated_premium_income field to layer data.
  • Removed brokerage_estimated_premium_income and loss_ratio_cap_estimated_premium_income fields from proportional pricing features.
  • Removed no_claim_bonus_estimated_premium_income and brokerage_estimated_premium_income fields from non-proportional pricing features.
  • Added adjustable_rate_estimated_premium_income field to proportional and non-proportional pricing features.

2026-08-17

  • Added optional rationale field to Deal object schema. This affects /risks, /risks/{risk_id} and /risks/historical endpoints.

2026-08-15

  • Added ceding_commission_estimated_premium_income, overriding_commission_estimated_premium_income, loss_ratio_cap_estimated_premium_income and no_claim_bonus_estimated_premium_income fields to layer data.

2026-08-14

  • Added quoting_closed status for Deal and Layer objects, replacing retracted. Note that retracted is deprecated and will be removed in the next API version; please use quoting_closed instead. This affects the status field of the Deal and Layer objects, and the status query param on /risks, /layers, /layers-v2 and /layers/{layer_id} endpoints.
  • Changed the risk_options.status field representation of the Deal object. Please use new archived/draft/quoting/quoting_closed/fot/bound values instead of the deprecated OptionArchived/OptionDraft/OptionQuoting/OptionRetracted/OptionInMarket/OptionBound values. This affects /risks and /risks/{risk_id} endpoints.

2026-08-13

  • Added optional programme_id, programme_name, inuring_benefits_from_risks, inuring_benefits_to_risks and co_brokered_risks fields to Deal object schema. This affects /risks and /risks/{risk_id} endpoints.

2026-08-12

  • Added optional reinsured_basis field to layer object schema. This affects POST /layers endpoint.
  • Added reinsured_basis field to historical layer object schemas. This affects POST /risks/historical endpoint.

2026-08-11

  • Added optional custom_name field to subsection object schema. This affects /risks, /risks/{risk_id}, /layers, /layers-v2 and /layers/{layer_id} endpoints.
  • Added optional custom_name field to ledger program product and ledger layer product object schemas. This affects /ledgers/{ledger_id}/programs, /ledgers/{ledger_id}/programs/{program_id}, /ledgers/{ledger_id}/programs/{program_id}/layers and /ledgers/{ledger_id}/programs/{program_id}/layers/{ledger_layer_id} endpoints.
  • Added risk_options.layers field to Deal object schema. This affects /risks and /risks/{risk_id} endpoints.

2026-08-10

  • Added order_estimated_premium_income and brokerage_estimated_premium_income fields to layer data.
  • Added ceding_commission_estimated_premium_income, overriding_commission_estimated_premium_income, brokerage_estimated_premium_income and loss_ratio_cap_estimated_premium_income fields to proportional pricing features.
  • Added no_claim_bonus_estimated_premium_income and brokerage_estimated_premium_income fields to non-proportional pricing features.

2026-08-06

  • Added optional premium_incomes field to layer and layer coverage object schemas. This affects GET /layers, /layers-v2, /layers/{layer_id} and /layers/{layer_id}/coverage endpoints.
  • Added optional premium_incomes field to create layer and create layer coverage data schemas. This affects POST /layers and /layers/{layer_id}/coverage endpoints.
  • Added optional premium_incomes field to deal, create deal, subsection, create subsection and historical deal/layer object schemas. This affects /risks, /risks/{risk_id}, POST /risks and /risks/historical endpoints.

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 ubtcdjw.e7e40a6e254de756af13c6f788be0fedc911ba4e

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 kctbnng.aa3f37c9420c0c9607b720daf62e37e43db87532

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 zpslbdf.af4a77a5c0bd35b00d4be9bbffaa08cd4e5fbda0

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 yghtuac.ef866a1c87f7b8d7ec4ab7a093a9b54911dcaabb

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 wdhtreh.26f8511c00909e96ce2f308e8f8a03c8bdf6c95e

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 unygdxl.c871ebca12df910dc945b8004b21c11f101042cd

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: 44c6ab49-4260-d399-98f9-4f32593fcf4e

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

header Parameters
Authorization
required
string
Example: Bearer qvkswea.d96afff449097eefcad124bb397885b940ace65f

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 ginitwk.90d19218f422a2740ef2ab1d930a92e761d78412

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: a41c2656-1bbf-b85e-2641-30de398d30dc

The ID of the user for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer tnkwfif.2ba8ed9b55284a75076b99b1376355e3ba3944e3

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 sunwgky.4b731c726b39ed54b19b68c78d33151a8adbfe3a

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" "quoting_closed" "fot" "in_market" "bound"
Example: status=locked

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

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 fbhjfpr.0e4e91fbe4b19a7aa2a1394da86e076cbb9c23ba

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 fbhjfpr.0e4e91fbe4b19a7aa2a1394da86e076cbb9c23ba

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)
Deprecated

Deprecated: use premium_incomes instead. The specification of premium income for a deal.

Array of objects (Estimated premium income data) non-empty
Array of objects (Program level feature)
program_name
required
string

The name of this deal.

rationale
string
Enum: "expertise" "fronting" "lack-of-capacity" "mandatory" "not-available"

Deal rationale.

Array of objects (Section)
object (Territorial scope)

Contains lists of included and excluded territories.

Responses

Request samples

Content type
application/json
{
  • "class_of_business": "retrocession",
  • "clients": [
    ],
  • "contract_reference": "LGX/2023/7834-01",
  • "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": "2024-06-01T00:00:00Z",
  • "original_insured": "Velora Co.",
  • "premium_income": {
    },
  • "premium_incomes": [
    ],
  • "program_level_features": [
    ],
  • "program_name": "Marine Motor XL",
  • "rationale": null,
  • "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: 5c036184-89a3-5a1f-a34b-e1fbd5a9a566

The ID of the deal to get information from

header Parameters
Authorization
required
string
Example: Bearer xvbxakd.7e81563379ccdc9b16d62aefce3ffea8051bfe13

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: 197c3e02-9b4b-2b39-bf1c-14d81824098b

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

header Parameters
Authorization
required
string
Example: Bearer rjqpdkc.6ddda9960b658b47c53c9b37bebfa6e892be92fd

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: 860789aa-1934-d9e4-55f3-59b806a44f11

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 urjwrdp.bb9c0ab2056fe88945106d881bd519bcd0649f9c

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: 3cba5737-b9a2-eb19-6eed-c67433a50d69

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

header Parameters
Authorization
required
string
Example: Bearer wvfvima.019b3642190c53f2fe596c0ae84e319c60081b29

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: f2b8e8fa-435b-0d44-43b4-86d9be9b017f

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

header Parameters
Authorization
required
string
Example: Bearer wvfvima.019b3642190c53f2fe596c0ae84e319c60081b29

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 expense caps)
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_expense_caps": [
    ],
  • "layer_internal_expenses": [
    ],
  • "layer_internal_references": [
    ],
  • "layer_max_recoverables": [
    ],
  • "layer_original_acquisition_costs": [
    ],
  • "layer_reporting_requirements": [
    ],
  • "market_info": [
    ],
  • "premium_payment_schedule": [
    ],
  • "premium_payment_warranty": 570
}

Response samples

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

Deals > Contractual terms

Get the contractual terms of a deal.

This operation returns the deal's contractual terms. Fields that have not been recorded are null.

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

The ID of the deal whose contractual terms are desired

header Parameters
Authorization
required
string
Example: Bearer yibqfjl.491bafb733055955126e10be978a2a0710740f88

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

Responses

Response samples

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

Set the contractual terms of a deal.

This operation replaces the deal's contractual terms as a whole: fields omitted from the request are cleared.

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

The ID of the deal whose contractual terms are set

header Parameters
Authorization
required
string
Example: Bearer yibqfjl.491bafb733055955126e10be978a2a0710740f88

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

Request Body schema: application/json
administrator
string

The administrator or managing underwriter of the business.

arbitration_seat
string

The seat of arbitration.

Array of objects (Money)
collateral
string

The collateral or funds-withheld mechanism.

execution_date
string <date>

The date the contract was executed.

governing_law
string

The law governing the contract.

Array of objects (Money)
late_payment_interest
string

The late payment interest terms, e.g. a reference rate plus a margin.

notes
string

Any terms that fit none of the fields above.

reporting_cadence
string

The reporting and settlement cadence, e.g. monthly bordereaux within 30 days, quarterly balances within 45 days.

run_off_or_cut_off
string
Enum: "run_off" "cut_off"

Whether liability runs off to natural expiry or is cut off at the expiry date.

service_of_suit
string

The service-of-suit nominee.

termination
string

The termination notice and any special termination triggers.

Responses

Request samples

Content type
application/json
{
  • "administrator": "Insurtech, Inc. dba Foresight Risk & Insurance Services",
  • "arbitration_seat": "San Francisco, California",
  • "cash_loss_threshold": [
    ],
  • "collateral": "Funds withheld; LOC or Trust at the reinsurer's option",
  • "execution_date": "2021-07-01",
  • "governing_law": "England and Wales",
  • "large_loss_notification_threshold": [
    ],
  • "late_payment_interest": "US Prime Rate + 3.0%",
  • "notes": null,
  • "reporting_cadence": "Monthly bordereaux within 30 days; quarterly balances settled within 45 days",
  • "run_off_or_cut_off": "cut_off",
  • "service_of_suit": "Mendes and Mount, New York",
  • "termination": "45 days' notice; special termination on insolvency or rating below A-"
}

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: b4538396-8f33-8d9c-de90-db7fe017f69f

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer cpfkqrs.98aac49c3704d5ced8ca8d4ef4cca0dd62ef59e9

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 zvpmzcr.3ac6baff6b2e6b1de628beaae27b2e15d5e93b04

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 (Estimated premium income data) non-empty
Array of objects (Premium payment)
required
Array of objects (Program level feature)
program_name
required
string

Name of the deal.

rationale
string
Enum: "expertise" "fronting" "lack-of-capacity" "mandatory" "not-available"

Deal rationale.

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": "retrocession",
  • "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-01-01T00:00:00Z",
  • "layers": [
    ],
  • "original_insured": "Original Insured Ltd",
  • "premium_income": {
    },
  • "premium_incomes": [
    ],
  • "premium_payment_schedule": [
    ],
  • "program_level_features": [
    ],
  • "program_name": "Retro Japan",
  • "rationale": "expertise",
  • "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=35991787-41d5-b24b-4023-c51cd43e29a7

Returns only layers for the deal with the specified ID.

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

Returns only layers for deals with the given status.
Note that retracted is deprecated and will be removed in the next API version; please use quoting_closed instead.
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 zczdiwh.fe1bbb62e05f7b1f823bf5332226b641d152a4b1

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 9e027052-9130-4dbf-86d3-534e5488eb94;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 zczdiwh.fe1bbb62e05f7b1f823bf5332226b641d152a4b1

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)
Array of objects (Estimated premium income data) non-empty
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.

reinsured_basis
string
Enum: "aggregate_basis" "any_one_risk_basis" "any_one_loss_basis" "any_one_event_basis" "each_and_every_loss_basis" "each_and_every_event_loss_occurrence_basis"

Deal layer reinsured basis.

risk_id
required
string <uuid>

Supercede-internal ID of the deal.

object (Layer income)
Deprecated

Deprecated: use premium_incomes instead.

subject_premium_basis
string
Deprecated
Enum: "gwp" "nwp" "gnwp" "gnep" "gnpi" "gnepi" "gep" "nep" "afp" "gcp" "ogp" "onp"

Deprecated: use premium_incomes instead. Deal layer subject premium basis.

subject_premium_percentage_us
number (Percentage) [ 0 .. 100 ]
Deprecated

Deprecated: use premium_incomes instead. 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": "AX25SPR0027",
  • "coverages": [
    ],
  • "description": "Layer description",
  • "lloyds_codes": [
    ],
  • "name": "The collapse of space and time",
  • "order": {
    },
  • "premium_incomes": [
    ],
  • "product": "clash_excess_of_loss",
  • "product_data": {
    },
  • "rate": {
    },
  • "reinsurance_period": "lod_period",
  • "reinsured_basis": "each_and_every_event_loss_occurrence_basis",
  • "risk_id": "82a7a7a0-0722-4764-b45b-7dc105bb9c48",
  • "subject_income": {
    },
  • "subject_premium_basis": "nep",
  • "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=c36dd2a6-c39f-3e68-c886-f2d4c4609e73

Returns only layers for the deal with the specified ID.

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

Returns only layers for deals with the given status.
Note that retracted is deprecated and will be removed in the next API version; please use quoting_closed instead.
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 qxvwvlh.e6eca89f760c527665171f4ccb4640de81daf8d1

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

Range
string
Example: id 64ebee22-410b-4c8b-a5f5-8379a3e7b6c0;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: 35991787-41d5-b24b-4023-c51cd43e29a7

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer iecgedd.d184f25793685d4c61bd40bde360d6c7bcd5bd1b

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: 5c036184-89a3-5a1f-a34b-e1fbd5a9a566

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer apkomru.f1f7647d2a5f1b8d70f248883986e96028c45b13

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: 3cba5737-b9a2-eb19-6eed-c67433a50d69

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer apkomru.f1f7647d2a5f1b8d70f248883986e96028c45b13

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)
Deprecated

Deprecated: use premium_incomes instead. 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.

Array of objects (Estimated premium income data) non-empty
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=c36dd2a6-c39f-3e68-c886-f2d4c4609e73

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

header Parameters
Authorization
required
string
Example: Bearer ffhqoss.0f799f90686d1b4a8495f6976c343cf121544492

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 ffhqoss.0f799f90686d1b4a8495f6976c343cf121544492

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": 89.15244130016069,
  • "expiry_date": "1868-01-13",
  • "layer_id": "5dc3045b-9d2e-4f66-8257-fb18b1ee81cb",
  • "line_size": 59.01054653658859,
  • "name": "Very generous quote",
  • "premium": {
    },
  • "rate_on_line": 6.0835099267569355,
  • "rate_on_premium": 85.85384236772241,
  • "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

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

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer fqlglbw.bdebe068c34cf92953788207c41db98d3e424209

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: 466eb767-9cb2-3e7f-0836-3d14dcfe4253

The ID of the deal

header Parameters
Authorization
required
string
Example: Bearer vrjynxx.352de2967c60f9cb78cdfed771ddb9b8c410d1ff

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=f2b8e8fa-435b-0d44-43b4-86d9be9b017f

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

header Parameters
Authorization
required
string
Example: Bearer vseygrn.814656e0c0ab22f8d5ac88b95753cc400aff67d4

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

Responses

Response samples

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

Set a line on a deal layer.

This operation records an authorised line for a deal layer. A signing can be specified when the line is created, or added to an existing line using this same operation. The line for a given layer and stamp is replaced as a whole: the authorisation percentage is restated on every call, and omitting the signing removes any existing signing.

header Parameters
Authorization
required
string
Example: Bearer vseygrn.814656e0c0ab22f8d5ac88b95753cc400aff67d4

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

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

The fraction of the layer that is authorised to be signed for this stamp.

comment
string

Free-text comment on the line.

expiry
string <date>

The date the authorisation expires.

layer_id
required
string <uuid>

A uuid representing the Supercede-internal ID of the layer the line is written against.

object (Signing)
stamp_name
required
string

The stamp authorising this line.

Responses

Request samples

Content type
application/json
{
  • "authorization_percentage": 87.69804467942961,
  • "comment": "Signed down from 10%",
  • "expiry": "1923-06-06",
  • "layer_id": "81ccf99d-189d-4528-a2a1-fb1431ad8c61",
  • "signing": {
    },
  • "stamp_name": "NEXANS RE SA"
}

Response samples

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

Deals > Market list

Get the market list for a deal.

This operation returns the market list for the deal given by risk_id, in the same shape the PUT operation accepts.

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

The ID of the deal whose market list is desired.

header Parameters
Authorization
required
string
Example: Bearer holotdq.5e28cf1ec92f075b2fb391f3874062947b647bbb

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

Responses

Response samples

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

Set the market list for a deal.

This operation allows you to overwrite the market list for the deal given by risk_id. Each participant's company is addressed by exactly one of company_id and company_name; a company_name is resolved against the exact catalogue name, and a name that matches no company fails the whole request.

query Parameters
risk_id
required
string <uuid>
Example: risk_id=b4538396-8f33-8d9c-de90-db7fe017f69f

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

header Parameters
Authorization
required
string
Example: Bearer holotdq.5e28cf1ec92f075b2fb391f3874062947b647bbb

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

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

An uuid representing the Supercede-internal ID of the company. Give exactly one of company_id and company_name.

company_name
string

The exact catalogue name of the company, as an alternative to company_id. A name that matches no company is rejected.

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: 2ee34d81-dabd-0994-a1ea-060c245f28d3

The ID of the deal for which comments are requested.

header Parameters
Authorization
required
string
Example: Bearer ymjtahh.bb17d9cd3143d280ffc994204ab93c6467ee8785

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: 3579da6a-81cd-e19c-7daa-dc70528ef9c0

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

header Parameters
Authorization
required
string
Example: Bearer ymjtahh.bb17d9cd3143d280ffc994204ab93c6467ee8785

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: 5c036184-89a3-5a1f-a34b-e1fbd5a9a566

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

comment_id
required
string <uuid>
Example: 466eb767-9cb2-3e7f-0836-3d14dcfe4253

The ID of the comment to be updated.

header Parameters
Authorization
required
string
Example: Bearer kaszzgo.f6c19f0f7e07aa9a4ce15b907628f2ff67ae29c6

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: 197c3e02-9b4b-2b39-bf1c-14d81824098b

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

comment_id
required
string <uuid>
Example: 65a57c48-9395-12ed-c7f8-a35e5ac4193f

The ID of the comment to be deleted.

header Parameters
Authorization
required
string
Example: Bearer kaszzgo.f6c19f0f7e07aa9a4ce15b907628f2ff67ae29c6

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: b4538396-8f33-8d9c-de90-db7fe017f69f

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

header Parameters
Authorization
required
string
Example: Bearer ylfxsvs.031833cc0f4a08c0bf7811f3e10206eb22850be6

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: b4538396-8f33-8d9c-de90-db7fe017f69f

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

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

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: 06d79fd8-9696-2508-f3dc-6f98f76adb6b

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

header Parameters
Authorization
required
string
Example: Bearer omkzlmq.53292c73d584dace5ab8c66c1911383726a8e758

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: 5c036184-89a3-5a1f-a34b-e1fbd5a9a566

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

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

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: 6a9eb56c-2e48-c1ff-b699-0b1fc2231b36

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

header Parameters
Authorization
required
string
Example: Bearer omkzlmq.53292c73d584dace5ab8c66c1911383726a8e758

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: 69c4b822-195e-29b8-b474-32f0210235ae

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer pmsvbrf.3c2a0326d70e11d323416dcc0e53029211aefbb0

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: 35991787-41d5-b24b-4023-c51cd43e29a7

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer pmsvbrf.3c2a0326d70e11d323416dcc0e53029211aefbb0

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: 6a9eb56c-2e48-c1ff-b699-0b1fc2231b36

The ID of the deal to which the subjectivity applies.

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

The ID of the subjectivity to be edited.

header Parameters
Authorization
required
string
Example: Bearer hwqtdni.e2a5ea54470e50531594f6dfcc332d2b6ca998fb

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: 4f7fa093-eea9-e7b6-8790-ab7e2a41aa46

The ID of the deal to which the subjectivity applies.

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

The ID of the subjectivity to be accepted.

header Parameters
Authorization
required
string
Example: Bearer dgxjpbe.cdf7c272cdba8a4d13eba50683121e0ec779639d

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: 3579da6a-81cd-e19c-7daa-dc70528ef9c0

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 3cba5737-b9a2-eb19-6eed-c67433a50d69

The ID of the subjectivity to be rejected.

header Parameters
Authorization
required
string
Example: Bearer hgktisa.0399754581d4664e69e00793a8eb7afc6e1f52e8

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: f2b8e8fa-435b-0d44-43b4-86d9be9b017f

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 4f576647-0058-226e-a240-be5024ff2cd8

The ID of the subjectivity to be retracted.

header Parameters
Authorization
required
string
Example: Bearer ivawvew.1184c63c5d022ef38e4b4c5bc3846f820fab4e86

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 flawbbc.0933434e3934320f8748e5f72bb55d30f610e4ea

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
}