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 

InputTypeDescription
commissionStatementLineItemIdStringID of the commission statement line item record.
matchingCriteriaPatternStringString that identifies the corresponding insurance policy.
failureStatusStringIndicates the status of the commission statement line item when the item’s processing fails.

Outputs 

OutputTypeDescription
commissionStatementLineItemsObjectCommission statement line item record populated with the insurance policy ID.

Example 

POST

This sample request is for the Find Insurance Policy action.

1{
2  "inputs": [
3    {
4      "commissionStatementLineItemId": "1Atxx0000004DeaCAE",
5	"matchingCriteriaPattern":"InsurancePolicyNumber:PolicyName AND InsurancePolicyEffectiveDate:EffectiveFromDate AND LineOfCoverage:LineOfCoverage AND ClientAccountName:NameInsured.Name"
6    }
7  ]
8}

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

1{
2  "actionName": "findInsurancePolicy",
3  "errors": null,
4  "invocationId": null,
5  "isSuccess": true,
6  "outcome": null,
7  "outputValues": {
8    "commissionStatementLineItem": {
9      "attributes": {
10        "type": "CommissionStatementLineItem",
11        "url": "/services/data/v64.0/sobjects/CommissionStatementLineItem/1Atxx0000004C92CAE"
12      },
13      "InsurancePolicyEffectiveDate": "2025-02-01",
14      "LineOfCoverage": "Medical",
15      "ReferenceRecordId": "0YTxx0000000001GAA",
16      "InsurancePolicyNumber": "test",
17      "Id": "1Atxx0000004C92CAE",
18      "ClientAccountName": "test"
19    }
20  },
21  "sortOrder": -1,
22  "version": 1
23 }