Renewals API

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

Create a renewal

POST /policies/{policyLocator}/renewals

RenewalCreateRequest

{
  // Required
  "renewalEndTimestamp" : integer

  // Optional
  "addExposures" : [ExposureCreateRequest]
  "addFieldGroups" : [FieldGroupCreateRequest]
  "endExposures" : [string]
  "fieldValues" : map<string,[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" : integer
  "documents" : [PolicyDocumentResponse]
  "endExposures" : [string]
  "fieldValues" : map<string,[string]>
  "locator" : string
  "policyholderLocator" : string
  "policyLocator" : string
  "productLocator" : string
  "removeFieldGroups" : [string]
  "renewalEndTimestamp" : integer
  "renewalStartTimestamp" : integer
  "state" : string application | quoted | accepted | issued | invalidated | discarded
  "updatedTimestamp" : integer
  "updateExposures" : [RenewalExposureUpdateRequest]
  "updateFieldGroups" : [FieldGroupUpdateRequest]

  // Optional
  "automatedUnderwritingResult" : AutomatedUnderwritingResultResponse
  "invoice" : PolicyInvoice2Response
  "issuedTimestamp" : integer
  "plannedInvoices" : [FutureInvoiceResponse]
}

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

Fetch a renewal’s pricing changes

GET /renewals/{renewalLocator}/price

Note: All pricing or underwriting rules run before acceptance are non-final.

Edit, accept, or issue a renewal

PATCH /renewals/{renewalLocator}

RenewalActionRequest

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

RenewalUpdateRequest

{
  // Optional
  "addExposures" : [ExposureCreateRequest]
  "addFieldGroups" : [FieldGroupCreateRequest]
  "endExposures" : [string]
  "fieldValues" : map<string,[string]>
  "removeFieldGroups" : [string]
  "renewalEndTimestamp" : integer
  "updateExposures" : [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

RenewalIssueRequest

{
  // Required
  "renewalEndTimestamp" : integer

  // Optional
  "policyUpdateRequest" : RenewalPolicyUpdateRequest
}

RenewalPolicyUpdateRequest

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

  // Optional
  "fieldValues" : map<string,[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

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