Note
This page is include on the internal docs build only.
Quick Quotes API
Endpoint Index
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 a Quick 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 |
Assign Quick Quote To Group | PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup |
Fetch Quick Quotes for a Group | GET /policy/{tenantLocator}/quickquotes/group/{locator}/list |
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} |
POST /policy/{tenantLocator}/quickquotes
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:QuickQuoteCreateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
QuickQuoteCreateRequest
¶requiredproductName stringstartTime datetimeendTime datetimecurrency stringdurationBasis Enum years | months | weeks | days | hourstimezone stringexpirationTime datetimedata map<string,object>contacts ContactRoles[]coverageTerms map<string,object>elements ElementResponse[]
PATCH /policy/{tenantLocator}/quickquotes/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
GET /policy/{tenantLocator}/quickquotes/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:read
QuickQuoteResponse
¶requiredlocator stringgroupLocator stringproductName stringquickQuoteState Enum draft | validated | priced | quoted | discardedelement ElementResponsecontacts ContactRoles[]optionalaccountLocator string?startTime datetime?endTime datetime?currency string?duration number?durationBasis Enum? years | months | weeks | days | hourstimezone string?anonymizedAt datetime?expirationTime datetime?validationResult ValidationResult?createdAt datetime?createdBy uuid?
GET /policy/{tenantLocator}/quickquotes/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:QuickQuoteListResponse
Security Group:quick-quotes  Permissions:read,list
QuickQuoteListResponse
¶requiredlistCompleted booleanitems QuickQuoteResponse[]
PATCH /policy/{tenantLocator}/quickquotes/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuotePriceResponse
Security Group:quick-quotes  Permission:write
QuickQuotePriceResponse
¶requiredquickQuoteLocator stringtenantLocator uuidproductName stringstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hoursquickQuoteState Enum draft | validated | priced | quoted | discardeditems PolicyChargeResponse[]state Enum draft | validated | priced | quoted | discarded (deprecated)optionalaccountLocator string?validationResult ValidationResult?
GET /policy/{tenantLocator}/quickquotes/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuotePriceResponse
Security Group:quick-quotes  Permission:read
POST /policy/{tenantLocator}/quickquotes/validatePreview
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:QuickQuoteCreateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:read
POST /policy/{tenantLocator}/quickquotes/pricePreview
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:QuickQuoteCreateRequest
Response:QuickQuotePriceResponse
Security Group:quick-quotes  Permission:read
Note
The 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.
PATCH /policy/{tenantLocator}/quickquotes/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:QuickQuoteUpdateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
QuickQuoteUpdateRequest
¶requiredstartTime datetimeendTime datetimecurrency stringexpirationTime datetimeelements ElementUpdateRequest[]removeContacts string[]removeCoverageTerms map<string,object>removeData map<string,object>setContacts ContactRoles[]setCoverageTerms map<string,object>setData map<string,object>
PUT /policy/{tenantLocator}/quickquotes/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:ElementResponse[]
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
DELETE /policy/{tenantLocator}/quickquotes/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:string[]
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
POST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
accountLocator | path | string | required |
markAsQuoted | query | boolean? | optional |
Response:QuickQuoteQuoteResponse
Security Group:quick-quotes  Permission:write
QuickQuoteQuoteResponse
¶requiredquickQuoteLocator stringtenantLocator uuidproductName stringstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hoursquickQuoteState Enum draft | validated | priced | quoted | discardedoptionalaccountLocator string?quote QuickQuoteQuoteDetails?validationResult ValidationResult?
QuickQuoteQuoteDetails
¶requiredlocator stringaccountLocator stringgroupLocator stringproductName stringquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discardedbillingLevel Enum account | inherit | policyelement ElementResponsecontacts ContactRoles[]optionalpolicyLocator string?quickQuoteLocator string?region string?autoRenewalPlanName string?delinquencyPlanName string?issuedTime datetime?startTime datetime?endTime datetime?acceptedTime datetime?currency string?duration number?durationBasis Enum? years | months | weeks | days | hourstimezone string?anonymizedAt datetime?billingTrigger Enum? accept | issueexpirationTime datetime?invoiceFeeAmount number?preferences PreferencesResponse?quoteNumber string?underwritingStatus string?validationResult ValidationResult?createdAt datetime?createdBy uuid?
POST /policy/{tenantLocator}/quickquotes/{locator}/copy
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/reset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
GET /policy/{tenantLocator}/quickquotes/group/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:QuickQuoteListResponse
Security Group:quick-quotes  Permissions:read,list
Contacts
POST /policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | string | required |
Request:ContactRoles
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
ContactRoles
¶requiredcontactLocator stringroles string[]
DELETE /policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | string | required |
contactLocator | path | string | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
GET /policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | string | required |
Response:ContactRoles[]
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | string | required |
contactLocator | path | string | required |
Request:ContactAssociationUpdateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write