Quick Quotes API
| Action | Endpoint |
|---|---|
| Create Quick Quote | POST/policy/{tenantLocator}/quickquotes |
| Validate Quick Quote | PATCH/policy/{tenantLocator}/quickquotes/{locator}/validate |
| Fetch Quick Quote | GET/policy/{tenantLocator}/quickquotes/{locator} |
| Fetch Multiple Quick Quotes | GET/policy/{tenantLocator}/quickquotes/list |
| Price AQuick Quote | PATCH/policy/{tenantLocator}/quickquotes/{locator}/price |
| Fetch Pricing For Quick Quote | GET/policy/{tenantLocator}/quickquotes/{locator}/price |
| Get a stateless validation preview for a quick quote | POST/policy/{tenantLocator}/quickquotes/validatePreview |
| Get a stateless price preview for a quick quote | POST/policy/{tenantLocator}/quickquotes/pricePreview |
| Update Quick Quote | PATCH/policy/{tenantLocator}/quickquotes/{locator} |
| Add Elements To Quick Quote | PUT/policy/{tenantLocator}/quickquotes/{locator}/elements |
| Delete Elements From Quick Quote | DELETE/policy/{tenantLocator}/quickquotes/{locator}/elements |
| Create Quote From Quick Quote | POST/policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator} |
| Copy Quick Quote | POST/policy/{tenantLocator}/quickquotes/{locator}/copy |
| Reset Quick Quote | PATCH/policy/{tenantLocator}/quickquotes/{locator}/reset |
| Discard Quick Quote | PATCH/policy/{tenantLocator}/quickquotes/{locator}/discard |
| Add quick quote contact | POST/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts |
| Delete quick quote contact | DELETE/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator} |
| Fetch quick quote contacts | GET/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts |
| Update quick quote contact | PATCH/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator} |
Create Quick Quote
Create Quick Quote
createQuickQuotePOST
/policy/{tenantLocator}/quickquotesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Request:
QuickQuoteCreateRequestResponse:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeQuickQuoteCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
productName | string | |
data | map<string, object> | |
contacts | ContactRoles[] | |
elements | ElementResponse[] |
Optional properties
| Property | Type | Description |
|---|---|---|
startTime | datetime? | |
endTime | datetime? | |
currency | string? | |
durationBasis | Enum? years | months | weeks | days | hours | |
timezone | string? | |
expirationTime | datetime? | |
jurisdiction | string? | |
coverageTerms | map<string, object>? |
Validate Quick Quote
Validate Quick Quote
validateQuickQuotePATCH
/policy/{tenantLocator}/quickquotes/{locator}/validateParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeFetch Quick Quote
Fetch Quick Quote
fetchQuickQuoteGET
/policy/{tenantLocator}/quickquotes/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
readQuickQuoteResponse
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
productName | string | |
quickQuoteState | Enum draft | validated | priced | quoted | discarded | |
element | ElementResponse | |
contacts | ContactRoles[] |
Optional properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid? | |
groupLocator | ulid? | |
startTime | datetime? | |
endTime | datetime? | |
currency | string? | |
duration | number? | |
durationBasis | Enum? years | months | weeks | days | hours | |
timezone | string? | |
anonymizedAt | datetime? | |
expirationTime | datetime? | |
jurisdiction | string? | |
validationResult | ValidationResult? | |
createdAt | datetime? | |
createdBy | uuid? |
Fetch Multiple Quick Quotes
Fetch Multiple Quick Quotes
fetchMultipleQuickQuotesGET
/policy/{tenantLocator}/quickquotes/listParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
offset | query | integer? | No | |
count | query | integer? | No | |
extended | query | boolean? | No | When false, returns a bare array. |
Response:
QuickQuoteListResponseSecurity Group:
quick-quotesPermissions:
read,listQuickQuoteListResponse
Required properties
| Property | Type | Description |
|---|---|---|
listCompleted | boolean | |
items | QuickQuoteResponse[] |
Price AQuick Quote
Price A Quick Quote
priceAQuickQuotePATCH
/policy/{tenantLocator}/quickquotes/{locator}/priceParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuotePriceResponseSecurity Group:
quick-quotesPermission:
writeQuickQuotePriceResponse
Required properties
| Property | Type | Description |
|---|---|---|
quickQuoteLocator | ulid | |
tenantLocator | uuid | |
productName | string | |
startTime | datetime | |
endTime | datetime | |
duration | number | |
durationBasis | Enum years | months | weeks | days | hours | |
quickQuoteState | Enum draft | validated | priced | quoted | discarded | |
items | PolicyChargeResponse[] | |
state | Enum draft | validated | priced | quoted | discardedDeprecated |
Optional properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid? | |
validationResult | ValidationResult? |
Fetch Pricing For Quick Quote
Fetch Pricing For Quick Quote
fetchPricingForQuickQuoteGET
/policy/{tenantLocator}/quickquotes/{locator}/priceParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuotePriceResponseSecurity Group:
quick-quotesPermission:
readGet a stateless validation preview for a quick quote
Get a stateless validation preview for a quick quote
quickQuoteValidatePreviewPOST
/policy/{tenantLocator}/quickquotes/validatePreviewParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Request:
QuickQuoteCreateRequestResponse:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
readGet a stateless price preview for a quick quote
Get a stateless price preview for a quick quote
quickQuotePricePreviewPOST
/policy/{tenantLocator}/quickquotes/pricePreviewParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Request:
QuickQuoteCreateRequestResponse:
QuickQuotePriceResponseSecurity Group:
quick-quotesPermission:
readThe Price A Quick Quote endpoint differs from Fetch Pricing For Quick Quote in that the former will advance the quick quote to priced state, and the latter will not change the state.
Update Quick Quote
Update Quick Quote
updateQuickQuotePATCH
/policy/{tenantLocator}/quickquotes/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Request:
QuickQuoteUpdateRequestResponse:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeQuickQuoteUpdateRequest
Required properties
| Property | Type | Description |
|---|---|---|
startTime | datetime | |
endTime | datetime | |
currency | string | |
expirationTime | datetime | |
elements | ElementUpdateRequest[] | |
removeContacts | ulid[] | |
removeCoverageTerms | map<string, object> | |
removeData | map<string, object> | |
setContacts | ContactRoles[] | |
setCoverageTerms | map<string, object> | |
setData | map<string, object> |
Optional properties
| Property | Type | Description |
|---|---|---|
jurisdiction | string? |
Add Elements To Quick Quote
Add Elements To Quick Quote
addElementsToQuickQuotePUT
/policy/{tenantLocator}/quickquotes/{locator}/elementsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Delete Elements From Quick Quote
Delete Elements From Quick Quote
deleteElementsFromQuickQuoteDELETE
/policy/{tenantLocator}/quickquotes/{locator}/elementsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Create Quote From Quick Quote
Create Quote From Quick Quote
createQuoteFromQuickQuotePOST
/policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
accountLocator | path | ulid | Yes | |
markAsQuoted | query | boolean? | No |
Response:
QuickQuoteQuoteResponseSecurity Group:
quick-quotesPermission:
writeQuickQuoteQuoteResponse
Required properties
| Property | Type | Description |
|---|---|---|
quickQuoteLocator | ulid | |
tenantLocator | uuid | |
productName | string | |
startTime | datetime | |
endTime | datetime | |
duration | number | |
durationBasis | Enum years | months | weeks | days | hours | |
quickQuoteState | Enum draft | validated | priced | quoted | discarded |
Optional properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid? | |
quote | QuickQuoteQuoteDetails? | |
validationResult | ValidationResult? |
QuickQuoteQuoteDetails
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
accountLocator | ulid | |
groupLocator | ulid | |
productName | string | |
quoteState | Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | |
billingLevel | Enum account | inherit | policy | |
element | ElementResponse | |
contacts | ContactRoles[] |
Optional properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid? | |
quickQuoteLocator | ulid? | |
region | string? | |
autoRenewalPlanName | string? | |
delinquencyPlanName | string? | |
issuedTime | datetime? | |
startTime | datetime? | |
endTime | datetime? | |
acceptedTime | datetime? | |
currency | string? | |
duration | number? | |
durationBasis | Enum? years | months | weeks | days | hours | |
timezone | string? | |
anonymizedAt | datetime? | |
expirationTime | datetime? | |
invoiceFeeAmount | number? | |
jurisdiction | string? | |
preferences | PreferencesResponse? | |
producerCode | string? | |
quoteNumber | string? | |
reservedPolicyNumber | string? | |
underwritingStatus | string? | |
validationResult | ValidationResult? | |
createdAt | datetime? | |
createdBy | uuid? |
Copy Quick Quote
Copy Quick Quote
copyQuickQuotePOST
/policy/{tenantLocator}/quickquotes/{locator}/copyParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Request:
QuoteGroupAssignmentRequestResponse:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeReset Quick Quote
Reset Quick Quote
resetQuickQuotePATCH
/policy/{tenantLocator}/quickquotes/{locator}/resetParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeDiscard Quick Quote
Discard Quick Quote
discardQuickQuotePATCH
/policy/{tenantLocator}/quickquotes/{locator}/discardParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeContacts
Add quick quote contact
Add quick quote contact
addQuickQuoteContactPOST
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contactsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
quoteLocator | path | ulid | Yes |
ContactRoles
Required properties
| Property | Type | Description |
|---|---|---|
contactLocator | ulid | |
roles | string[] |
Delete quick quote contact
Delete quick quote contact
deleteQuickQuoteContactDELETE
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
quoteLocator | path | ulid | Yes | |
contactLocator | path | ulid | Yes |
Response:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
writeFetch quick quote contacts
Fetch quick quote contacts
fetchQuickQuoteContactsGET
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contactsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
quoteLocator | path | ulid | Yes |
Response:
ContactRoles[]Security Group:
quick-quotesPermission:
writeUpdate quick quote contact
Update quick quote contact
updateQuickQuoteContactPATCH
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
quoteLocator | path | ulid | Yes | |
contactLocator | path | ulid | Yes |
Request:
ContactAssociationUpdateRequestResponse:
QuickQuoteResponseSecurity Group:
quick-quotesPermission:
write