Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Policy Business APIs
Resources
Requests
Responses
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Policy Standard Objects
Insurance Policy Administration Apex Reference
Insurance Policy Developer Journey
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Insurance Policy Business APIs

Manage policy transactions such as issuance, endorsement, renewal, and cancellation. Calculate term taxes based on transaction types and policy durations.

This table lists the available Insurance Policy Administration resources.

Resource Description
/connect/insurance/policies/policyId/cancel (POST) Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON.
/connect/insurance/policies/policyId/endorse (POST) Endorse the latest version of the insurance policy based on the context ID and effective date.
/connect/insurance/policies/policyId?_qs=contextOnly=true (GET) Get the ID of the context and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.
/connect/insurance/policies (POST) Use the context ID provided in the input JSON to generate a new insurance policy.
/connect/insurance/policies/policyId/renew (POST) Use the context ID of an existing policy to renew a policy. Modify the renewal date and also add optional fields and additional information in the input JSON.
/connect/insurance/policies/policyId/out-of-sequence-endorsement (POST) Create an out-of-sequence endorsement for an insurance policy.
/connect/insurance/policies/policyId/reinstate (POST) Reinstate a previously canceled insurance policy.
/connect/insurance/policies/multi-root (POST) Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy.
/connect/insurance/policies/multi-root/endorse (POST) Asynchronously endorse a multi-root insurance policy along with its child policies.
/connect/insurance/policies/multi-root/renew (POST) Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies.