Find Insurance Policy Action

Get the insurance policy associated with a commission statement line item that matches the specified criteria, and update the status of the commission statement line item record.

This action is available in API version 63.0 and later.

Special Access Rules

The Find Insurance Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need Insurance Commission Management and Insurance Brokerage User permission sets.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/findInsurancePolicy

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: GET, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input Type Description
commissionStatementLineItemId String ID of the commission statement line item record.
matchingCriteriaPattern String String that identifies the corresponding insurance policy.
failureStatus String Indicates the status of the commission statement line item when the item's processing fails.

Outputs

Output Type Description
commissionStatementLineItem sObject Commission statement line item record populated with the insurance policy ID.

Example

POST

This sample request is for the Find Insurance Policy action.

{
  "inputs": [
    {
      "commissionStatementLineItemId": "1Atxx0000004DeaCAE",
	"matchingCriteriaPattern":"InsurancePolicyNumber:PolicyName AND InsurancePolicyEffectiveDate:EffectiveFromDate AND LineOfCoverage:LineOfCoverage AND ClientAccountName:NameInsured.Name"
    }
  ]
}

This is the sample response for the Find Insurance Policy action.

{
  "actionName": "findInsurancePolicy",
  "errors": null,
  "invocationId": null,
  "isSuccess": true,
  "outcome": null,
  "outputValues": {
    "commissionStatementLineItem": {
      "attributes": {
        "type": "CommissionStatementLineItem",
        "url": "/services/data/v64.0/sobjects/CommissionStatementLineItem/1Atxx0000004C92CAE"
      },
      "InsurancePolicyEffectiveDate": "2025-02-01",
      "LineOfCoverage": "Medical",
      "ReferenceRecordId": "0YTxx0000000001GAA",
      "InsurancePolicyNumber": "test",
      "Id": "1Atxx0000004C92CAE",
      "ClientAccountName": "test"
    }
  },
  "sortOrder": -1,
  "version": 1
 }