Socotra
API Reference

Quick Quotes API

ActionEndpoint
Create Quick QuotePOST/policy/{tenantLocator}/quickquotes
Validate Quick QuotePATCH/policy/{tenantLocator}/quickquotes/{locator}/validate
Fetch Quick QuoteGET/policy/{tenantLocator}/quickquotes/{locator}
Fetch Multiple Quick QuotesGET/policy/{tenantLocator}/quickquotes/list
Price AQuick QuotePATCH/policy/{tenantLocator}/quickquotes/{locator}/price
Fetch Pricing For Quick QuoteGET/policy/{tenantLocator}/quickquotes/{locator}/price
Get a stateless validation preview for a quick quotePOST/policy/{tenantLocator}/quickquotes/validatePreview
Get a stateless price preview for a quick quotePOST/policy/{tenantLocator}/quickquotes/pricePreview
Update Quick QuotePATCH/policy/{tenantLocator}/quickquotes/{locator}
Add Elements To Quick QuotePUT/policy/{tenantLocator}/quickquotes/{locator}/elements
Delete Elements From Quick QuoteDELETE/policy/{tenantLocator}/quickquotes/{locator}/elements
Create Quote From Quick QuotePOST/policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
Copy Quick QuotePOST/policy/{tenantLocator}/quickquotes/{locator}/copy
Reset Quick QuotePATCH/policy/{tenantLocator}/quickquotes/{locator}/reset
Discard Quick QuotePATCH/policy/{tenantLocator}/quickquotes/{locator}/discard
Add quick quote contactPOST/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
Delete quick quote contactDELETE/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}
Fetch quick quote contactsGET/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
Update quick quote contactPATCH/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}

Create Quick Quote

Create Quick QuotecreateQuickQuote
POST/policy/{tenantLocator}/quickquotes

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
Security Group:quick-quotes
Permission:
write
QuickQuoteCreateRequest

Required properties

PropertyTypeDescription
productNamestring
datamap<string, object>
contactsContactRoles[]
elementsElementResponse[]

Optional properties

PropertyTypeDescription
startTimedatetime?
endTimedatetime?
currencystring?
durationBasisEnum? years | months | weeks | days | hours
timezonestring?
expirationTimedatetime?
jurisdictionstring?
coverageTermsmap<string, object>?

Validate Quick Quote

Validate Quick QuotevalidateQuickQuote
PATCH/policy/{tenantLocator}/quickquotes/{locator}/validate

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write

Fetch Quick Quote

Fetch Quick QuotefetchQuickQuote
GET/policy/{tenantLocator}/quickquotes/{locator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
read
QuickQuoteResponse

Required properties

PropertyTypeDescription
locatorulid
productNamestring
quickQuoteStateEnum draft | validated | priced | quoted | discarded
elementElementResponse
contactsContactRoles[]

Optional properties

PropertyTypeDescription
accountLocatorulid?
groupLocatorulid?
startTimedatetime?
endTimedatetime?
currencystring?
durationnumber?
durationBasisEnum? years | months | weeks | days | hours
timezonestring?
anonymizedAtdatetime?
expirationTimedatetime?
jurisdictionstring?
validationResultValidationResult?
createdAtdatetime?
createdByuuid?

Fetch Multiple Quick Quotes

Fetch Multiple Quick QuotesfetchMultipleQuickQuotes
GET/policy/{tenantLocator}/quickquotes/list

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
offsetqueryinteger?No
countqueryinteger?No
extendedqueryboolean?NoWhen false, returns a bare array.
Security Group:quick-quotes
Permissions:
read,list
QuickQuoteListResponse

Required properties

PropertyTypeDescription
listCompletedboolean
itemsQuickQuoteResponse[]

Price AQuick Quote

Price A Quick QuotepriceAQuickQuote
PATCH/policy/{tenantLocator}/quickquotes/{locator}/price

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write
QuickQuotePriceResponse

Required properties

PropertyTypeDescription
quickQuoteLocatorulid
tenantLocatoruuid
productNamestring
startTimedatetime
endTimedatetime
durationnumber
durationBasisEnum years | months | weeks | days | hours
quickQuoteStateEnum draft | validated | priced | quoted | discarded
itemsPolicyChargeResponse[]
stateEnum draft | validated | priced | quoted | discardedDeprecated

Optional properties

PropertyTypeDescription
accountLocatorulid?
validationResultValidationResult?

Fetch Pricing For Quick Quote

Fetch Pricing For Quick QuotefetchPricingForQuickQuote
GET/policy/{tenantLocator}/quickquotes/{locator}/price

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
read

Get a stateless validation preview for a quick quote

Get a stateless validation preview for a quick quotequickQuoteValidatePreview
POST/policy/{tenantLocator}/quickquotes/validatePreview

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
Security Group:quick-quotes
Permission:
read

Get a stateless price preview for a quick quote

Get a stateless price preview for a quick quotequickQuotePricePreview
POST/policy/{tenantLocator}/quickquotes/pricePreview

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
Security Group:quick-quotes
Permission:
read

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.

Update Quick Quote

Update Quick QuoteupdateQuickQuote
PATCH/policy/{tenantLocator}/quickquotes/{locator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write
QuickQuoteUpdateRequest

Required properties

PropertyTypeDescription
startTimedatetime
endTimedatetime
currencystring
expirationTimedatetime
elementsElementUpdateRequest[]
removeContactsulid[]
removeCoverageTermsmap<string, object>
removeDatamap<string, object>
setContactsContactRoles[]
setCoverageTermsmap<string, object>
setDatamap<string, object>

Optional properties

PropertyTypeDescription
jurisdictionstring?

Add Elements To Quick Quote

Add Elements To Quick QuoteaddElementsToQuickQuote
PUT/policy/{tenantLocator}/quickquotes/{locator}/elements

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Request:ElementResponse[]
Security Group:quick-quotes
Permission:
write

Delete Elements From Quick Quote

Delete Elements From Quick QuotedeleteElementsFromQuickQuote
DELETE/policy/{tenantLocator}/quickquotes/{locator}/elements

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Request:ulid[]
Security Group:quick-quotes
Permission:
write

Create Quote From Quick Quote

Create Quote From Quick QuotecreateQuoteFromQuickQuote
POST/policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
accountLocatorpathulidYes
markAsQuotedqueryboolean?No
Security Group:quick-quotes
Permission:
write
QuickQuoteQuoteResponse

Required properties

PropertyTypeDescription
quickQuoteLocatorulid
tenantLocatoruuid
productNamestring
startTimedatetime
endTimedatetime
durationnumber
durationBasisEnum years | months | weeks | days | hours
quickQuoteStateEnum draft | validated | priced | quoted | discarded

Optional properties

PropertyTypeDescription
accountLocatorulid?
quoteQuickQuoteQuoteDetails?
validationResultValidationResult?
QuickQuoteQuoteDetails

Required properties

PropertyTypeDescription
locatorulid
accountLocatorulid
groupLocatorulid
productNamestring
quoteStateEnum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
billingLevelEnum account | inherit | policy
elementElementResponse
contactsContactRoles[]

Optional properties

PropertyTypeDescription
policyLocatorulid?
quickQuoteLocatorulid?
regionstring?
autoRenewalPlanNamestring?
delinquencyPlanNamestring?
issuedTimedatetime?
startTimedatetime?
endTimedatetime?
acceptedTimedatetime?
currencystring?
durationnumber?
durationBasisEnum? years | months | weeks | days | hours
timezonestring?
anonymizedAtdatetime?
expirationTimedatetime?
invoiceFeeAmountnumber?
jurisdictionstring?
preferencesPreferencesResponse?
producerCodestring?
quoteNumberstring?
reservedPolicyNumberstring?
underwritingStatusstring?
validationResultValidationResult?
createdAtdatetime?
createdByuuid?

Copy Quick Quote

Copy Quick QuotecopyQuickQuote
POST/policy/{tenantLocator}/quickquotes/{locator}/copy

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write

Reset Quick Quote

Reset Quick QuoteresetQuickQuote
PATCH/policy/{tenantLocator}/quickquotes/{locator}/reset

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write

Discard Quick Quote

Discard Quick QuotediscardQuickQuote
PATCH/policy/{tenantLocator}/quickquotes/{locator}/discard

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
locatorpathulidYes
Security Group:quick-quotes
Permission:
write

Contacts

Add quick quote contact

Add quick quote contactaddQuickQuoteContact
POST/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
quoteLocatorpathulidYes
Request:ContactRoles
Security Group:quick-quotes
Permission:
write
ContactRoles

Required properties

PropertyTypeDescription
contactLocatorulid
rolesstring[]

Delete quick quote contact

Delete quick quote contactdeleteQuickQuoteContact
DELETE/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
quoteLocatorpathulidYes
contactLocatorpathulidYes
Security Group:quick-quotes
Permission:
write

Fetch quick quote contacts

Fetch quick quote contactsfetchQuickQuoteContacts
GET/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
quoteLocatorpathulidYes
Response:ContactRoles[]
Security Group:quick-quotes
Permission:
write

Update quick quote contact

Update quick quote contactupdateQuickQuoteContact
PATCH/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
quoteLocatorpathulidYes
contactLocatorpathulidYes
Security Group:quick-quotes
Permission:
write

See Also

On this page