API Reference

Create outward program

post
https://{host}/platform/riskdata/v1/businesshierarchysets//programs
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 calendar date format.

date

Default end date in ISO 8601 calendar date format.

organization
object

Details about the organization attached to this program.

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.

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 about 6 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
*/*
application/json

Updated about 6 hours ago

Did this page help you?