Skip to main content
POST
Calculate policy quote

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required

the policy id

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

simulatedAt
string<date-time>

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Body

application/json
options
object[]
additionalQuoteComponentsAndPercentages
object

Additional quote components and percentages

manualComponentValues
object

Manual component values as a flat { componentId: value } map for config-driven manual components.

skipValidation
boolean

Debug: force a quote to happen even if there are no changes to quote

brokerageFeesOverride
object[]

Brokerage fees to calculate quote with

periodDurationOverride
object

Policy period duration value to calculate quote with

customFieldsToOverride
object[]

Custom fields you want to calculate quote with

assetIds
string[]

The assets ids to quote

Pattern: ^asset(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
prorated
boolean

Decide if the quote should be prorated according to the invoicing frequency

Response

policy
object
assets
object[]
outputCustomFields
object

Custom fields computed by the pricing engine (e.g. Excel outputs)

breakdown
object

Price breakdown computed from product priceBreakdown config