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	RenewalCreateRequest	required

• Response:RenewalResponse

RenewalCreateRequest

{
  // Required
  renewalEndTimestamp : timestamp

  // Optional
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  fieldValues : map<string,[string]>
  newPaymentScheduleName : string
  removeFieldGroups : [string]
  state : string application | quoted | accepted | issued
  updateExposures : [RenewalExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]
}

List renewals for a policy

GET /policies/{policyLocator}/renewals

• Request:

  Name	Position	Type	Required
  policyLocator	path	string	required

• Response:[RenewalResponse]

RenewalResponse

{
  // Required
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  createdTimestamp : timestamp
  documents : [PolicyDocumentResponse]
  endExposures : [string]
  fieldValues : map<string,[string]>
  locator : string
  policyholderLocator : string
  policyLocator : string
  productLocator : string
  removeFieldGroups : [string]
  renewalEndTimestamp : timestamp
  renewalStartTimestamp : timestamp
  state : string application | quoted | accepted | issued | invalidated | discarded
  updatedTimestamp : timestamp
  updateExposures : [RenewalExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  automatedUnderwritingResult : AutomatedUnderwritingResultResponse
  invoice : PolicyInvoice2Response
  issuedTimestamp : timestamp
  newPaymentScheduleName : string
  plannedInvoices : [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	RenewalActionRequest	required
  renewalLocator	path	string	required

• Response:RenewalResponse

RenewalActionRequest

{
  // Optional
  action : string discard | quote | accept | issue | invalidate | update
  conflictHandling : string block | invalidate
  renewalUpdate : RenewalUpdateRequest
}

RenewalUpdateRequest

{
  // Required
  addFieldGroups : [FieldGroupCreateRequest]
  removeFieldGroups : [string]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  addExposures : [ExposureCreateRequest]
  endExposures : [string]
  fieldValues : map<string,[string]>
  newPaymentScheduleName : string
  renewalEndTimestamp : timestamp
  updateExposures : [RenewalExposureUpdateRequest]
}

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	RenewalIssueRequest	required

• Response:Policy2Response

RenewalIssueRequest

{
  // Required
  renewalEndTimestamp : timestamp

  // Optional
  policyUpdateRequest : RenewalPolicyUpdateRequest
}

RenewalPolicyUpdateRequest

{
  // Required
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  removeFieldGroups : [string]
  updateExposures : [RenewalExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  fieldValues : map<string,[string]>
  newPaymentScheduleName : string
}

RenewalExposureUpdateRequest

{
  // Required
  addFieldGroups : [FieldGroupCreateRequest]
  addPerils : [PerilCreateRequest]
  endPerils : [string]
  exposureLocator : string
  fieldValues : 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	RenewalIssueRequest	required

• Response:PolicyPriceChangeResponse

This endpoint will price a prospective renewal without actually creating or issuing it.