Renewals API

See the Renewals Feature Guide for more information about using this feature.

Endpoint Index

Action	Endpoint
Create a renewal	POST /policies/{policyLocator}/renewals
List renewals for a policy	GET /policies/{policyLocator}/renewals
Fetch a renewal	GET /renewals/{renewalLocator}
Fetch a renewal's underwriting decision	GET /renewals/{renewalLocator}/automatedUnderwritingResult
Fetch a renewal's pricing changes	GET /renewals/{renewalLocator}/price
Update a renewal	PATCH /renewals/{renewalLocator}/update
Quote a renewal	PATCH /renewals/{renewalLocator}/quote
Accept a renewal	PATCH /renewals/{renewalLocator}/accept
Invalidate a renewal	PATCH /renewals/{renewalLocator}/invalidate
Discard a renewal	PATCH /renewals/{renewalLocator}/discard
Issue a renewal	PATCH /renewals/{renewalLocator}/issue
Get policy as if the renewal were issued	GET /renewals/{renewalLocator}/policyWhenIssued
Edit, accept, or issue a renewal	PATCH /renewals/{renewalLocator}

Details

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
state string application | quoted | accepted | issued
overrideResourcesAsOfTimestamp timestamp
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
updateExposures [RenewalExposureUpdateRequest]
endExposures [string]
autofill [string]
newPaymentScheduleName string

List renewals for a policy¶

GET /policies/{policyLocator}/renewals

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [RenewalResponse]

RenewalResponse¶

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

optional
issuedTimestamp timestamp
overrideResourcesAsOfTimestamp timestamp
resourcesAsOfTimestamp timestamp
automatedUnderwritingResult AutomatedUnderwritingResultResponse
invoice PolicyInvoiceResponse
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.

Update a renewal¶

PATCH /renewals/{renewalLocator}/update

Request:

Name	Position	Type	Required
actionRequest	body	RenewalActionRequest	required
renewalLocator	path	string	required

Response: RenewalResponse

Quote a renewal¶

PATCH /renewals/{renewalLocator}/quote

Request:

Name	Position	Type	Required
actionRequest	body	RenewalActionRequest	required
renewalLocator	path	string	required

Response: RenewalResponse

Accept a renewal¶

PATCH /renewals/{renewalLocator}/accept

Request:

Name	Position	Type	Required
actionRequest	body	RenewalActionRequest	required
renewalLocator	path	string	required

Response: RenewalResponse

Invalidate a renewal¶

PATCH /renewals/{renewalLocator}/invalidate

Request:

Name	Position	Type	Required
actionRequest	body	RenewalActionRequest	required
renewalLocator	path	string	required

Response: RenewalResponse

Discard a renewal¶

PATCH /renewals/{renewalLocator}/discard

Request:

Name	Position	Type	Required
renewalLocator	path	string	required

Response: RenewalResponse

Issue a renewal¶

PATCH /renewals/{renewalLocator}/issue

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
renewalUpdate RenewalUpdateRequest
conflictHandling string block | invalidate

RenewalUpdateRequest¶

required
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]

optional
overrideResourcesAsOfTimestamp timestamp
renewalEndTimestamp timestamp
fieldValues map<string,[string]>
addExposures [ExposureCreateRequest]
updateExposures [RenewalExposureUpdateRequest]
endExposures [string]
autofill [string]
newPaymentScheduleName string
resetOverrideResourcesAsOfTimestamp boolean

Get policy as if the renewal were issued¶

GET /renewals/{renewalLocator}/policyWhenIssued

Request:

Name	Position	Type	Required
renewalLocator	path	string	required

Response: PolicyResponse

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 Renewals

Edit, accept, or issue a renewal¶

PATCH /renewals/{renewalLocator}

Request:

Name	Position	Type	Required
actionRequest	body	RenewalActionRequest	required
renewalLocator	path	string	required

Response: RenewalResponse

This endpoint consolidating all renewal actions into a single PATCH call is considered legacy. The same functionality has been split out into individual actions, listed above, and will afford more granular control when using Roles & Permissions.

See the Legacy Renewals topic for information on older renewal functionality.