Endorse a policy
In an agent portal, agents can create an endorsement transaction in order to submit changes to an existing policy.
- Identify the policy transaction.
- Submit and process the endorsement.
Identify the policy transaction
Initiating an endorsement starts with an agent deciding to create a new transaction on a policy. Then, agent portal calls an API to determine the types of transactions that are valid for a policy.
Once an agent selects an endorsement transaction, the agent portal must note the code value of the transaction as it is required to request the transaction in a later step.
For example, the following steps may occur:- View the policy details:
- The portal submits the following API
call:
GET /policies/systemid
- The portal displays the policy details provided in the response.
- The portal submits the following API
call:
- View the list of available transactions:
- The portal submits the following API call:
GET /policies/systemid/availableTransactions
- The portal provides the user a list of available transactions based on the API response.
- The agent selects the Endorsement transaction.
- From the API response, the portal notes the value of the
Endorsement option.
[ ... "value": "Cancellation", "name": "Cancellation" }, { "value": "Endorsement", "name": "Endorsement" }, ... ]
- The portal submits the following API call:
Submit and process the endorsement
Submitting and processing an endorsement request starts with the agent portal calling an API to initiate an endorsement. Then, the system creates an application and the agent processes the application.
For example, the following steps may occur:
- Start the endorsement transaction request:
- The portal executes the following API call:
Endpoint POST /policies/systemId/startTransactionRequest
Example Request Body { "effectiveDate": "YYYY-MM-DD", "transactionCd": "Endorsement" }
Provide the
value
of the Endorsement transaction as the transactionCd. - From the API response header, note the systemID of the
application in the location field of the API response
header:
... location: https://hostname/coreapi/v5/applications/systemID ...
- The portal executes the following API call:
- View the new application
- The portal executes the following API
call:
GET /applications/systemid
- The portal displays the application details provided in the API response.
- The agent completes the application.
- The portal executes the following API
call: