Renewals API¶
See the Renewals Feature Guide for more information about using this feature.
Create a renewal¶
POST /policies/{policyLocator}/renewals
Request:
Name
Position
Type
Required
policyLocator
path
string
required
renewalCreateRequest
body
required
Response:
RenewalResponse
RenewalCreateRequest¶
{// RequiredrenewalEndTimestamp : timestamp// OptionaladdExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]fieldValues : map<string,[string]>removeFieldGroups : [string]state : string application | quoted | accepted | issuedupdateExposures : [RenewalExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]}
List renewals for a policy¶
GET /policies/{policyLocator}/renewals
Request:
Name
Position
Type
Required
policyLocator
path
string
required
Response:
[RenewalResponse]
RenewalResponse¶
{// RequiredaddExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]createdTimestamp : timestampdocuments : [PolicyDocumentResponse]endExposures : [string]fieldValues : map<string,[string]>locator : stringpolicyholderLocator : stringpolicyLocator : stringproductLocator : stringremoveFieldGroups : [string]renewalEndTimestamp : timestamprenewalStartTimestamp : timestampstate : string application | quoted | accepted | issued | invalidated | discardedupdatedTimestamp : timestampupdateExposures : [RenewalExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]// OptionalautomatedUnderwritingResult : AutomatedUnderwritingResultResponseinvoice : PolicyInvoice2ResponseissuedTimestamp : timestampplannedInvoices : [FutureInvoiceResponse]price : PolicyPriceChangeResponse}
Fetch a renewal¶
GET /renewals/{renewalLocator}
Request:
Name
Position
Type
Required
renewalLocator
path
string
required
Response:
RenewalResponse
Fetch a renewal’s underwriting decision¶
GET /renewals/{renewalLocator}/automatedUnderwritingResult
Request:
Name
Position
Type
Required
renewalLocator
path
string
required
Response:
AutomatedUnderwritingResultResponse
Fetch a renewal’s pricing changes¶
GET /renewals/{renewalLocator}/price
Request:
Name
Position
Type
Required
renewalLocator
path
string
required
Response:
PolicyPriceChangeResponse
Note: All pricing or underwriting rules run before acceptance are non-final.
Edit, accept, or issue a renewal¶
PATCH /renewals/{renewalLocator}
Request:
Name
Position
Type
Required
actionRequest
body
required
renewalLocator
path
string
required
Response:
RenewalResponse
RenewalActionRequest¶
{// Optionalaction : string discard | quote | accept | issue | invalidate | updateconflictHandling : string block | invalidaterenewalUpdate : RenewalUpdateRequest}
RenewalUpdateRequest¶
{// OptionaladdExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]fieldValues : map<string,[string]>removeFieldGroups : [string]renewalEndTimestamp : timestampupdateExposures : [RenewalExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]}
Return policy with accepted renewal transaction as issued.¶
GET /renewals/{renewalLocator}/policyWhenIssued
Request:
Name
Position
Type
Required
renewalLocator
path
string
required
Response:
Policy2Response
This endpoint will return what the policy will look like, including pricing and characteristics, assuming the renewal is issued. It will only work on accepted
renewals.
Legacy Renewal API (Deprecated)¶
The following endpoint will create and issue a renewal in one shot. This endpoint is deprecated and may be removed in a future release.
Issue a renewal¶
POST /policy/{policyLocator}/issueRenewal
Request:
Name
Position
Type
Required
policyLocator
path
string
required
request
body
required
Response:
Policy2Response
RenewalIssueRequest¶
{// RequiredrenewalEndTimestamp : timestamp// OptionalpolicyUpdateRequest : RenewalPolicyUpdateRequest}
RenewalPolicyUpdateRequest¶
{// RequiredaddExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]removeFieldGroups : [string]updateExposures : [RenewalExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]// OptionalfieldValues : map<string,[string]>}
RenewalExposureUpdateRequest¶
{// RequiredaddFieldGroups : [FieldGroupCreateRequest]addPerils : [PerilCreateRequest]endPerils : [string]exposureLocator : stringfieldValues : map<string,[string]>removeFieldGroups : [string]updateFieldGroups : [FieldGroupUpdateRequest]updatePerils : [PerilUpdateRequest]}
Preview a renewal’s pricing¶
POST /policy/{policyLocator}/previewRenewalPrice
Request:
Name
Position
Type
Required
policyLocator
path
string
required
request
body
required
Response:
PolicyPriceChangeResponse
This endpoint will price a prospective renewal without actually creating or issuing it.