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
Edit, accept, or issue a renewal	PATCH /renewals/{renewalLocator}
Get policy as if the renewal were issued	GET /renewals/{renewalLocator}/policyWhenIssued

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
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
updateExposures [RenewalExposureUpdateRequest]
endExposures [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
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.

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

RenewalUpdateRequest¶

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

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

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

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