Products API

Endpoint Index

ActionEndpoint
Fetch all product configurations in a tenantGET /products/
GET /products/{configVersion}
Fetch configuration information for policyholdersGET /products/policyholder

Products and Policies

Fetch all product configurations in a tenant
GET /products/
GET /products/{configVersion}

Note

In addition to normal products, a global product will also be returned. This product is used for system purposes and can generally be disregarded.

ProductConfigurationResponse
required
name string
policyConfiguration PolicyConfigurationResponse

optional
claimConfiguration ClaimConfigurationResponse
premiumReportingConfiguration [PremiumReportingConfigurationResponse]
configVersion integer
PolicyDocumentConfiguration
required
displayName string
fileName string
generatingEvent string quote | accept | issue
templateName string
type string pdf | html

optional
pageLayout DocumentPageLayout
DocumentPageLayout
optional
marginBottom number
marginLeft number
marginRight number
marginTop number
orientation string portrait | landscape
pageSize string letter | legal | tabloid | a3 | a4 | a5 | b4 | b5
PolicyInvoicingConfiguration
required
generatingEvent string quote | accept | issue
ExposureConfigurationResponse
required
name string
displayName string
FrontendExternalDataCallConfiguration
required
targetFields [string]
triggerField string
FieldConfiguration
required
name string
title string
order integer
type string

optional
condition map<string,string>
heading string
optional boolean

Depending on the value of the type attribute, this will appear as one of the following subtypes:

DateFieldConfiguration
required
name string
title string
order integer
precision string year | month | day | second

optional
condition map<string,string>
heading string
maximum string
minimum string
newline boolean
optional boolean
showCalendar boolean
width integer
DateOffsetConfiguration
required
amount integer
field string year | month | day | second

optional
roundToDay boolean
EmailFieldConfiguration
required
name string
title string
order integer

optional
condition map<string,string>
heading string
newline boolean
optional boolean
width integer
GroupFieldConfiguration
required
name string
title string
order integer

optional
condition map<string,string>
heading string
maximum integer
newline boolean
optional boolean
repeatable boolean
width integer
LookupFieldConfiguration
required
name string
title string
order integer
table string

optional
condition map<string,string>
heading string
match [string]
newline boolean
optional boolean
public boolean
width integer
MediaFieldConfiguration
required
name string
title string
order integer

optional
condition map<string,string>
heading string
newline boolean
optional boolean
repeatable boolean
width integer
NumberFieldConfiguration
required
name string
title string
order integer

optional
maximum number
minimum number
condition map<string,string>
decimalPlaces integer
heading string
newline boolean
optional boolean
width integer
SelectFieldConfiguration
required
name string
title string
order integer
values [string]

optional
condition map<string,string>
heading string
newline boolean
optional boolean
repeatable boolean
width integer
StringFieldConfiguration
required
name string
title string
order integer

optional
condition map<string,string>
heading string
maximum integer
multiline boolean
newline boolean
optional boolean
regex string
width integer
PerilConfigurationResponse
required
name string
displayName string

optional
deductible number
lumpSumPayment number
indemnityInAggregate string
indemnityPerEvent string
indemnityPerItem string
TaxConfigurationResponse
required
name string
displayName string
FeeConfigurationResponse
required
name string
displayName string
EndorsementConfigurationResponse
required
name string
displayName string
reprice string always | never | input | all
RenewalConfigurationResponse
required
PaymentTermsResponse
required
amount integer
unit string day
PaymentScheduleResponse
required
name string
displayName string
type string total | custom | monthly | annually | semiannually | quarterly | every_two_weeks | every_week | 2Pay | 5Pay
CancellationConfigurationResponse
CancellationReasonConfigurationResponse
required
name string
title string

optional
cancellationCategories [string]
ReinstatementConfigurationResponse
required

optional
defaultDeadlineDays integer
LapseConfigurationResponse
required
gracePeriodDays integer
reinstatementPeriodDays integer
PremiumReportingConfigurationResponse
required
id string
premiumReportingCalculationRevision string
productRevisionLocator string
reportName string
tenantLocator string
ClaimConfigurationResponse
required

optional
subClaimConfiguration SubClaimConfigurationResponse
SubClaimConfigurationResponse
required
ReminderConfigurationResponse
required
name string
enabled boolean
from string policy.end
offset string
ProductScriptingConfig
required
createInstallments ProductPluginConfig
getDataAutofill ProductPluginConfig
getPerilRates ProductPluginConfig
getPostIssuanceResult ProductPluginConfig
getPostPaymentReversal ProductPluginConfig
getPreGraceResult ProductPluginConfig
getProrationResult ProductPluginConfig
getUnderwritingResult ProductPluginConfig
ProductPluginConfig
required
enabled boolean
path string
type string echo | rater | underwriter | prorater | installments | postIssuance | postPaymentReversal | preGrace | dataAutofill

ReminderOffset

These strings indicate a fixed duration of time using a subset of the ISO-8601 date format.

Examples of valid offsets are: "-1d" or "-7d" or "-30d" (for one/seven/thirty days before)

Such durations are subtracted from the occurrence described in the reminder’s "from" property.

For example, a reminder "-7d" from "policy.end" will fire one week before the policy ends.

Policyholders

Fetch configuration information for policyholders
GET /products/policyholder
PolicyholderConfigurationResponse
required

Note

There are some aspects of policyholder configuration that are not included in the response from the Products API. This endpoint is intended to provide information about field definitions. Some properties have been changed or omitted to conform with the FieldConfiguration object used in the main products API:

  • prompt is returned in the property title.

  • section.title is returned in the property heading.

  • visibleIf is not included.