API Reference

Search HD step policies

get
https://{host}/platform/riskdata/v1/exposures//steppolicies

Returns list of HD step policies.

An HD step policy is an insurance payment structure that follows a step-like function, where the payment amount is a prescribed value over a certain interval (step) and jumps to another prescribed value in an adjacent interval. HD step policies support both simple steps and interaction steps.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

📷

Step Policy (DLM model)

Risk Data API supports both HD step policies and DLM step policies. This operation returns only HD step policies.

To search for DLM step policies, use the Search Policies operation.

Path Params
int64
required
≥ 1

ID of EDM.

Query Params
string

Query string to select response data based on property values.

PropertyComparisonList
stepPolicyId=, !=, <=, >=, >, <NOT IN, IN
stepPolicyNumber=, !=, LIKE NOT LIKENOT IN, IN
stepPolicyName=, !=, LIKE NOT LIKENOT IN, IN
accountId=, !=, <=, >=, >, <NOT IN, IN
stepOrderId=, !=, <=, >=, >, <NOT IN, IN
causeOfLoss=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
payoutAmount=, !=, <=, >=, >, <NOT IN, IN
share=, !=, <=, >=, >, <NOT IN, IN
excessAmount=, !=, <=, >=, >, <NOT IN, IN
currency=, !=, LIKE NOT LIKENOT IN, IN
isPerRiskSubject=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
subjectFunction=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
payoutFunction=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
childOrderId=, !=, LIKE NOT LIKENOT IN, IN
coverageBase=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
limitGU=, !=, <=, >=, >, <, LIKE NOT LIKENOT IN, IN
inceptionDate=, !=, <=, >=, >, <
expirationDate=, !=, <=, >=, >, <`

All properties support creating compound queries using the AND and OR logical operators. See Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: accountId, causeOfLoss, childOrderId, coverageBase, currency, excessAmount, expirationDate, inceptionDate, isPerRiskSubject, limitGU, lobId, payoutAmount, payoutFunction, share, stepOrderId, stepPolicyId, stepPolicyName, stepPolicyNumber, subjectFunction

See Response Pagination.

int32

Number of records returned per page. See Response Pagination

int32

Number of the page displaying the returned records, starting at 0.

Responses

Updated over 1 year ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated over 1 year ago