API docs by Redocly

Supercede API V2

Download OpenAPI specification:

Support: support@supercede.com

Introduction

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

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

Access

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

Pagination

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

Changelog

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

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

2025-12-30

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

2025-12-17

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

2025-12-08

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

2025-11-14

  • Added industry_loss_warranty to layer data.

2025-11-10

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

2025-11-07

  • Removed deprecated collateral field from layer data.

2025-11-03

  • Added layer_aggregate_limits to layer data.

2025-10-30

  • Added not_taken_up_reason field to layer and deal data.

2025-10-24

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

2025-09-29

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

2025-09-18

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

2025-06-18

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

2025-06-04

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

2025-05-23

  • Added layer_reporting_requirements field to deal accounting data.

2025-05-20

  • Added premium_basis field to deal subsection data.

2025-05-19

  • Added premium_payment_warranty to deal accounting data.

2025-05-15

  • Added cash_layer_loss_limit field to deal accounting data.

2025-05-06

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

2025-03-31

  • Added perils field to layer and coverage data.

2025-03-27

  • Added territorial_scope field to layer and coverage data.

2025-03-21

  • Added subject_premium_basis field to layer data.

2025-02-11

  • Increased detail in custom premium data.

2025-02-04

  • Removed comment field from quote endpoints.

2024-11-15

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

2024-10-19

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

2024-05-13

  • Added layer_original_acquisition_cost to risk accounting data.

2024-05-09

  • Added fot, archived, and bound risk statuses.

2024-04-25

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

2023-11-24

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

2023-11-21

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

2023-11-06

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

2023-10-31

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

2023-10-13

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

2023-10-10

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

2023-09-29

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

Catalogue

Get all non-broker organisations on the platform

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

header Parameters
Authorization
required
string
Example: Bearer nnpabtx.693fbee49d3b73e353ab005f12736e7226d3690b

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 lzspeey.f3abb93b4faa09219b8c844b4670ea774848d87d

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 xnkakur.24669fd79f612542a5de26e4db305776094d3837

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

Responses

Response samples

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

Get all sublines of business available to your organisation

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

query Parameters
lob_id
string
Example: lob_id=Agriculture

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

header Parameters
Authorization
required
string
Example: Bearer zydncxa.cfdbc8cd7f379a1f766df441bcc75225d7a5976c

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 zrexmgk.1ee93c31861b2a8d51a3d3fc9904003fc8bfedec

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 drgptlq.6a4aab51c54bf587a4128533809edc271c52d37f

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: bd84cae9-0532-ea06-8f0f-0626fcde1fe9

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

header Parameters
Authorization
required
string
Example: Bearer mkedjti.b63a5b139838c577f03b4662e47a29ee6c0ddaeb

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 kjdlque.6e06281d684008178dc3b06796426a40d8090ff9

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: efb8958f-ab71-ff9b-f10e-31a0fda37ef1

The ID of the user for which information is desired.

header Parameters
Authorization
required
string
Example: Bearer qlobffo.579e7a450b2f694abb467d8babd2762e29724e1a

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 tdylazr.c06e9ae4c419ff0d46aa1b97540df30b97bfced9

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=retracted
cover_note_status
string (Cover note status)
Enum: "submitted" "pending"
Example: cover_note_status=submitted
is_not_taken_up
boolean (Deal hasn't been taken up)
Example: is_not_taken_up=true
header Parameters
Authorization
required
string
Example: Bearer xzukppe.95554a297cfb03014c2ccc36f8b5ef82ac9be743

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 xzukppe.95554a297cfb03014c2ccc36f8b5ef82ac9be743

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": null,
  • "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": "Nexus Systems",
  • "premium_income": null,
  • "program_level_features": [
    ],
  • "program_name": "Multi-Section ILW",
  • "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: 9570de98-7bd5-f909-fdc9-4453bc08731b

The ID of the deal to get information from

header Parameters
Authorization
required
string
Example: Bearer clpwqoc.5a3b0afce0108485a3aa5e2d11f8ed0cce4adbd7

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: b2ec9429-d000-840c-69ce-f2c86fefbec2

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

header Parameters
Authorization
required
string
Example: Bearer wogzjmo.0bd5f8e9077bf6e28a86909faedcc14bd9a80ae2

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: baae9bee-787c-0b48-eac7-c61e6c58659c

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 mtohvai.9b1472ffdc9c145a88f61cf034570c5f27734a35

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: 8507bcc6-8de4-624d-b9f3-4c199f951848

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

header Parameters
Authorization
required
string
Example: Bearer ryoaswg.3aedd0cc61393c5c9b536c63b0350316ba76d6d5

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: 8507bcc6-8de4-624d-b9f3-4c199f951848

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

header Parameters
Authorization
required
string
Example: Bearer ryoaswg.3aedd0cc61393c5c9b536c63b0350316ba76d6d5

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 camodle.c6cc94b12baa96c995f9ee9d3c260bafe12216fd

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=34b799fe-855b-ecca-9029-d7e41e2992d5

Returns only layers for the deal with the specified ID.

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

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

year
integer <int64>
Example: year=2021

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

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

Returns only layers for deals with the specified inception date.

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

Returns only layers for deals with the specified expiration date.

header Parameters
Authorization
required
string
Example: Bearer yvqxygt.d79a442b6379a524a3825397db407a0bbabb2e31

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

Range
string
Example: id 110b92e4-4f22-4e25-b923-44b5cb9007fb;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 yvqxygt.d79a442b6379a524a3825397db407a0bbabb2e31

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": "AX25SPR0027",
  • "coverages": [
    ],
  • "custom_premium": {
    },
  • "lloyds_codes": [
    ],
  • "name": "Dental prosthetics for monitor lizards",
  • "order": {
    },
  • "product": "clash_excess_of_loss",
  • "product_data": {
    },
  • "rate": {
    },
  • "reinsurance_period": "yoa_period",
  • "risk_id": "e46cce4d-bd02-4180-ba2e-0e77ebdca4f7",
  • "subject_income": {
    },
  • "subject_premium_basis": "gnwp",
  • "target_reinsurance_premium": {
    },
  • "territorial_scope": {
    }
}

Response samples

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

Get all deal layers.

Returns a list of deal layers available to the user.

query Parameters
risk_id
string <uuid>
Example: risk_id=d864bc38-b3c6-3499-b331-d9df4099c112

Returns only layers for the deal with the specified ID.

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

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 hqhscta.10921cd969558f6509f7ee5efc93ba66806b0782

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

Range
string
Example: id 0cb364aa-b13a-4e2d-abe2-ec553ac5cd4d;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: b84b6464-965c-ba45-ca87-26eb58377bff

The ID of the requested layer.

header Parameters
Authorization
required
string
Example: Bearer eoxclrl.e7f363679214564c968c316bd1a21be4a9987d70

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=13071376-e447-28b2-63f9-373270c84165

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

header Parameters
Authorization
required
string
Example: Bearer rssihpq.38d63c374dd306e286f9ed6353005147e84c4177

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 rssihpq.38d63c374dd306e286f9ed6353005147e84c4177

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": 74.79474323866803,
  • "expiry_date": "1894-05-16",
  • "layer_id": "b1f2eb42-9fea-47d2-818a-a0d1dfc442e5",
  • "line_size": 77.32205741758216,
  • "name": "Minimum quota",
  • "premium": {
    },
  • "rate_on_line": 48.03878555173067,
  • "rate_on_premium": 81.55335909405159,
  • "reference": "GE:10-04195XL",
  • "stamp_name": "ODDYSSEY REINSURANCE CO."
}

Response samples

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

Retract a deal from Quoting or FOT stage

header Parameters
Authorization
required
string
Example: Bearer blnjmas.445dddabfd2a9eea92e3531afafacfb49056f4b1

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 ttmuhwh.7f2baa1bd382bbef5a7c84a09bdae20a72e059a9

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=85d99e7b-e723-0c34-5098-c6f2943e9e3d

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

header Parameters
Authorization
required
string
Example: Bearer bphafsw.7914aabe8b90472579ccb6956a2c72611facbeb4

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=420137ff-3227-d7ae-bce5-824cfdee2ff5

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

header Parameters
Authorization
required
string
Example: Bearer yhqtkiy.c4fb1ce15dab2e3017c35b12f79c75e9a22fe339

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: a1ee9b93-ef34-0d95-7a1c-b224b60cc516

The ID of the deal for which comments are requested.

header Parameters
Authorization
required
string
Example: Bearer issedtu.97e39bdad80737876f46daa098ce108658e0f56b

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: a1ee9b93-ef34-0d95-7a1c-b224b60cc516

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

header Parameters
Authorization
required
string
Example: Bearer issedtu.97e39bdad80737876f46daa098ce108658e0f56b

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: 02e004bc-c3eb-6c4e-0112-9c80e6317f62

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

comment_id
required
string <uuid>
Example: 340110c5-b23b-2296-aee2-d3be64003308

The ID of the comment to be updated.

header Parameters
Authorization
required
string
Example: Bearer gdgquaf.26c56e79c23e329c0ea023fb1e1c9fb5ed75ab7d

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: 02e004bc-c3eb-6c4e-0112-9c80e6317f62

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

comment_id
required
string <uuid>
Example: 340110c5-b23b-2296-aee2-d3be64003308

The ID of the comment to be deleted.

header Parameters
Authorization
required
string
Example: Bearer gdgquaf.26c56e79c23e329c0ea023fb1e1c9fb5ed75ab7d

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: 8ceb1cb0-e635-a401-e891-bf210afc8112

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

header Parameters
Authorization
required
string
Example: Bearer nlueqcd.b8642d1778c6cdbb449cd721542cd9a00773c351

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: 4b609cc5-bcea-30cb-7123-41aad6be46ae

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

company_id
required
string <uuid>
Example: 212e8fe0-a067-2b01-7789-87108bfd96b8

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: 8b6e174b-383a-ec58-bada-88a3e3d6e884

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

header Parameters
Authorization
required
string
Example: Bearer fzvkojs.1ef83e8a00deca1791891637cf6f3c22108e0f3a

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_non_prop_api"
}

Response samples

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

Delete pricing features for a specific stamp and layer.

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

path Parameters
risk_id
required
string <uuid>
Example: 4b609cc5-bcea-30cb-7123-41aad6be46ae

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

company_id
required
string <uuid>
Example: 212e8fe0-a067-2b01-7789-87108bfd96b8

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: 8b6e174b-383a-ec58-bada-88a3e3d6e884

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

header Parameters
Authorization
required
string
Example: Bearer fzvkojs.1ef83e8a00deca1791891637cf6f3c22108e0f3a

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: 11f9dbb6-e467-e4b5-0d57-21885c862798

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer agiqldr.337fd1ac6d74a5e6061bdf8115b8be8f7243d831

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: 11f9dbb6-e467-e4b5-0d57-21885c862798

The ID of the deal for which subjectivities are requested.

header Parameters
Authorization
required
string
Example: Bearer agiqldr.337fd1ac6d74a5e6061bdf8115b8be8f7243d831

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: 555769ba-32d2-0b69-03dd-4586a699a2f7

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 803c3c8e-3898-b3fa-2ddf-eabe002f4369

The ID of the subjectivity to be edited.

header Parameters
Authorization
required
string
Example: Bearer ywyyogd.e8621647ef85b58d1c61e32a3d2007fad0fb9410

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": "Subject to no known or reported losses prior to inception."
}

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: f949b99b-0a96-9850-e827-a8948662af2f

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 22510c61-6045-8392-37b5-5f4a7b980f27

The ID of the subjectivity to be accepted.

header Parameters
Authorization
required
string
Example: Bearer scrsrsa.ab0e1a0d6652c77dbc87466c4b7ea83f4ef65c86

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: e690f722-3e04-2ce4-e914-9d18abfa376d

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: ee7d5a2d-72b9-aa96-45f4-fc1ac8a0ab4b

The ID of the subjectivity to be rejected.

header Parameters
Authorization
required
string
Example: Bearer kbjazoc.2b2577aab6e108120c0706cabb2b7ce267b800c5

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: e3b58951-4661-42ce-f7e0-e434e7b7e578

The ID of the deal to which the subjectivity applies.

subjectivity_id
required
string <uuid>
Example: 8253533b-5e26-f09b-5b24-02cfeb7d8111

The ID of the subjectivity to be retracted.

header Parameters
Authorization
required
string
Example: Bearer doaadgo.f37f146d46fd6cae99fc90810d32e15ea5688eef

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 jhouezy.1e34ce8840c79f77011975d725d53da53ff5a1e3

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

Responses

Response samples

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