API Reference

Create outward program

post
https://{host}/platform/riskdata/v1/businesshierarchysets//programs

Creates an outward program, a program that captures outward reinsurance structures.

An outward program is a collection of program treaties (contracts) through which losses are ceded to a reinsurer. The outward program enables you to model and quantify actual or proposed reductions in net exposure to a business hierarchy. These programs support proportional and non-proportional treaty templates, and custom treaties having user-defined CDL covers.

Every outward program belongs to a business hierarchy set, a securable that defines access rights to a collection of business hierarchies and their corresponding outward programs.

If successful, returns 201 Created HTTP response and adds job to the workflow engine queue.

🪰

Entitlements

RI-TREATYIQ

Headers
string

If specified, this request is idempotent. See Idempotent Requests

Path Params
number
required

ID of business hierarchy set that secures this program.

Body Params
string
required

Must be unique within program set

string

Description of this program

string
enum
required
Allowed:
int32
tags
array of strings

List of data tag IDs to apply to this program.

tags
string
enum

Status of this program.

Allowed:
string

Notes regarding this program.

string

Name of contract template that defines program.

string

Three-letter ISO 4217 country code that identifies the default currency this program treaty’s terms. For example, USD.

string

Current stage of the program's underwriting process.

date

Default start date in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

date

Default end date in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

organization
object
number

Amount paid to a reinsurer to participate in this program

number

Other expenses, e.g. legal fees.

string

Custom metadata for program, business hierarchy, or program treaty.

string

Custom metadata for program, business hierarchy, or program treaty.

string

Custom metadata for program, business hierarchy, or program treaty.

string

Custom metadata for program, business hierarchy, or program treaty.

string
string
boolean | null
Defaults to false

If true this is the main program between the insurer and cedant.

riskBlocks
array of objects

List of risk blocks covered by this program.

riskBlocks
treaties
array of objects

List of program treaties (retrocession treaties) attached to this program.

treaties
displayColumns
array of objects
displayColumns
Responses

Updated 6 months ago

Language
Credentials
URL
Response 
 Choose an example:
*/*
application/json
Updated 6 months ago