Insurance Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Insurance Developer Resources
Insurance Product Administration
Insurance Quoting
Insurance Policy Administration
Insurance Policy Business APIs
Resources
Cancel Insurance Policy (POST)
Endorse Insurance Policy (POST)
Insurance Policy Details (GET)
Issue Insurance Policy (POST)
Renew Insurance Policy (POST)
Requests
Responses
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Policy Administration Apex Reference
Insurance Policy Developer Journey
Insurance Brokerage
PDF

Issue Insurance Policy (POST)

Use the context ID provided in the input JSON to generate a new insurance policy.
Resource
/connect/insurance/policies
Resource example
https://yourInstance.salesforce.com/services/data/v64.0/connect/insurance/policies
Available version
63.0
HTTP methods
POST
Request body for POST
JSON example
{
    "contextId": "3561319f267fd53380bc38c049a01c8089876e833a321860766d35a9c40b67df",
    "insurancePolicy": {
        "policyName": "Mr. Bret Lees Policy",
        "policyNumber": "Policy-Bret-OneYear",
        "effectiveFromDate": "2024-01-01",
        "effectiveToDate": "2024-10-31"
    },
    "transaction": {
        "name": <transcation_name>
    },
"additionalFields":{
      "additionalFieldsList":[
         {
            "additionalFieldsMapValue":{
               "instanceKey":"autoRoot",
               "fields":{
                  "Checkbox__c":"true",
                  "Currency__c":123456,
                  "Date__c":"2024-11-30",
                  "DateTime__c":"2024-12-31T01:34:00.000Z",
                  "Email__c":"testuser@sf.com"
               }
            }
         }

  {
           "additionalFieldsMapValue":{
             "instanceKey":"autoDriver",
              "fields":{
                 "TextEncr__c":"233345675676",
                 "Url__c":"https://thisistest.com",
                  "Time__c":"12:05:00.000Z"
           }
        }
     }
      ]
   }
}
Properties
Name Type Description Required or Optional Available Version
additionalFields Additional Fields Map Value[] The JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API is generated by the Create Insurance Quote API. Optional 63.0
contextId String Context ID of the quote that’s used to create the policy. Required 63.0
insurancePolicy Insurance Policy Input[] The JSON structure that’s used to create the policy. It contains fields and values from the Insurance Policy object. Optional 63.0
transactionRecord Insurance Policy Transaction Input[] The JSON structure that’s used to override transaction information. Optional 63.0
Response body for POST
Policy