API Reference
- GETList branches on the policy
- GETGet Policy
- PATCHEdit Policy
- GETList my policies
- POSTTEST Calculate invoices
- GETList policy documents.
- POSTGenerate Upload Document Url
- DELDelete policy documents by id.
- GETGetPolicyClaimsHistorydeprecated
- POSTDeclare Policy Claims Historydeprecated
- POSTConfirm the policy. The policy and its assets all become [CONFIRMED](#object-statuses) and can no longer be modified in the New Business flow.
- POSTGenerate signature request for a policy.
- GETGetPremiumSchedule
- GETList policy, asset or customer events.
- POSTPush policy custom event.
- POSTQuote the policy
- POSTCalculate policy quote
- GETGet policy premium projection
- POSTStop the policy. The policy and its assets all become [STOPPED](#object-statuses) and can no longer be modified.
- POSTUpdate policy quote components
- POSTSuspend the policy
- POSTActivate the policy
- POSTSet policy brokerage fees
- POSTNon delegated quote policy
- GET
Copy
{
"policy": {
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
},
"assets": [
{
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
}
]
}policy
Calculate policy quote
Calculate quote information for a policy without actually quoting it. The quote contains the full pricing details, i.e. base prices for assets or policy, the multipliers applied, peril breakdown, etc.
POST
/
policies
/
{policyId}
/
calculate-quote
Copy
{
"policy": {
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
},
"assets": [
{
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
}
]
}Path Parameters
the policy id
Query Parameters
Optional: the whenAt datetime
Optional: the simulatedAt datetime
Optional: the branchId
Body
application/json
The assets ids to quote
Response
Show child attributes
Show child attributes
Quote id
Entity the quote is for
Show child attributes
Show child attributes
components of the quote
Show child attributes
Show child attributes
Available options:
PREMIUM, PERIL, FEE, TAX, SPECIAL Show child attributes
Show child attributes
Charge type of component
Available options:
ONE_TIME, SPOT, RECURRING Show child attributes
Show child attributes
Quote id
Entity the quote is for
Show child attributes
Show child attributes
components of the quote
Show child attributes
Show child attributes
Available options:
PREMIUM, PERIL, FEE, TAX, SPECIAL Show child attributes
Show child attributes
Charge type of component
Available options:
ONE_TIME, SPOT, RECURRING Was this page helpful?
⌘I