Renew a policy

In an agent portal, agents can renew an existing policy.

Based on product configuration, agents can directly renew a policy with a Renewal transaction. Or, they can renew a policy with a Renewal Start and Renewal Activate transaction.

Processing a renewal transaction includes the following steps:
  1. Identify the policy transaction code.
  2. Submit and process the renewal.

Identify the policy transaction code

Initiating a renewal starts with an agent deciding to create a Renewal transaction on a policy. Then, agent portal calls an API to determine the types of transactions that are valid for a policy.


Process to identify the policy transaction code.

Once an agent selects a Renewal transaction, the agent portal must note the code value of the transaction as it is required to request the transaction in a later step.

  1. View the policy details:
    1. The portal submits the following API call:
      GET /policies/systemid
    2. The portal displays the policy details provided in the response.
  2. View the list of available transactions:
    1. The portal submits the following API call: 
      GET /policies/systemid/availableTransactions
    2. The portal provides the user a list of available transactions based on the API response.
    3. The agent selects the Renewal transaction.
    4. From the API response, the portal notes the value of the Renewal option.
      ...
    "value": "Non-Renewal",
    "name": "Non-Renewal"
  },
  {
    "value": "Renewal",
    "name": "Renewal"
  },
  {
    "value": "Rewrite-New",
    "name": "Rewrite-New"
  },
...

Submit and process the renewal

Submitting and processing the renewal starts with the agent portal calling an API to initiate the renewal. Then, the system creates an application and the agent processes the application.

  1. Start the Renewal transaction request:
    1. The portal gathers renewal details from the agent.
    2. The portal executes the following API call:
      Endpoint 
      POST /policies/systemId/startTransactionRequest
      Example Request Body 
      {
  "effectiveDate": "YYYY-MM-DD",
  "transactionCd": "Renewal",
  "description": "Renewing for another year"
}
      Note: The values will differ based on agent input.
    3. From the API response header, note the systemID of the application in the location field:
      ...
 location: https://hostname/coreapi/v5/applications/systemID
 ...
  2. View the new application
    1. The portal executes the following API call:
      GET /applications/systemid
    2. The portal displays the application details provided in the API response.
    3. The agent completes the application.