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
Additional Fields Field Set Input
Additional Fields Map Value
Cancel Policy Input
Endorse Policy Input
Insurance Policy Input
Insurance Policy Transaction Input
Issue Policy Input
Out-of-Sequence Endorse Policy Input
Reinstate Policy Input
Renew Policy Input
Insurance Policy Billing Details
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

Insurance Policy Input

Input representation of insurance policy details.

JSON Example

1insurancePolicy": {
2  "policyName": "Mr. Bret Lees Policy",
3  "policyNumber": "Policy-Bret-OneYear",
4  "effectiveFromDate": "2024-01-01",
5  "effectiveToDate": "2024-10-31",
6  "referencePolicyNumber": "00AXSYH567INS"
7}

Properties

Name Type Description Required or Optional Available Version
effectiveFromDate String Date that the policy is effective from.

This property isn't applicable to the policy endorsement and reinstatement APIs.

 Optional 63.0
effectiveToDate String Expiration date of the policy.

This property isn't applicable to the policy endorsement and reinstatement APIs.

 Optional 63.0
policyName String Name of the insurance policy. Optional 63.0
policyNumber String Number of the policy. Optional 63.0
referencePolicy​Number String Reference number that's used to link policies across terms.

If not specified, policies are linked by the insurance policy ID.

This property is applicable to the Issue Policy API and supports both single-root and multi-root policies.

 Optional 65.0