---
schema_version: "1"
id: caf8907cd967a11f3795d756508b64350941a80da3da0a8d83442f1c7e10ffe6
title: Get Policy
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/connect_responses_get_policy_output.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_policy_output.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9b4183757d9ed79d0a2842d64f569f059c39e5fe7dd286ee9b1b402d654b4291
description: Output representation of policy details.
---
# Get Policy

Output representation of policy details.

## JSON Example

This example shows a sample response when you pass a policy ID in the get policy request.

{  
   “insurancepolicy” : {
      “id” : “xxxxxxxXxx”,
      “policyName” : “policyName”,
      “policyNumber” : “PN-10012”,
      “universalPolicyNumber” : “TNS-123981”,
      “effectiveFromDate” : “2023/01/01”, //ISO format - yyyy-mm-dd
      “effectiveToDate” : “2023/12/31”,
      ..
      ..
      “insurancePolicyCoverages” : \[
                        {
                            “coverageName” : “Collision”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        },
                        {
                            “coverageName” : “Theft Protection”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        }
                  \]
      “insurancePolicyAssets” : \[
            {
                  “assetName” : “Audi A3”,
                  “effectiveFromDate” : “2023/01/01”,
                  “effectiveToDate” : “2023/12/31”,
                  ..
                  ..
                  “insurancePolicyCoverages” : \[
                        {
                            “coverageName” : “Collision”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        },
                        {
                            “coverageName” : “Theft Protection”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        }
                  \]
            },
            {
                  “assetName” : “Audi A4”,
                  “effectiveFromDate” : “2023/01/01”,
                  “effectiveToDate” : “2023/12/31”,
                  ..
                  ..
                  “insurancePolicyCoverages” : \[
                        {
                            “coverageName” : “Collision”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        },
                        {
                            “coverageName” : “Theft Protection”,
                            “effectiveFromDate” : “2023/01/01”,
                            “effectiveToDate” : “2023/12/31”,
                            ..
                            ..
                        }
                  \]
            }
      \]
   }                                                                  
}

This example shows a sample response when you pass the contextOnly query parameter as true in the request. When the contextOnly parameter is true, the API returns a context ID along with the insurance policy details.

{
    "contexId": "e02036acf464f323f197c200895fec48a6a62ae3c711b3603609f08817c4af48
",
    "insurancePolicy": {}
}

This example shows a sample response when expand\[attributes\] query parameter is set to true.

{
    "insurancePolicy": {
        "effectiveFromDate": "2024-01-01",
        "effectiveToDate": "2024-09-29",
        "originalEffectiveFromDate": "2024-01-01",
        "originalEffectiveToDate": "2024-12-31",
        "active": true,
		....
....
        "grossWrittenPremium": 1678.28,
        "insurancePolicyAssets": \[
            {
                "effectiveFromDate": "2024-01-01",
                "effectiveToDate": "2024-09-29",
                "assetName": "Auto Bundle",
                "id": "0YWSG0000000N4f4AE",
			....
			....
                "insurancePolicyAssets": \[\],
                "insurancePolicyParticipants": \[
                    {
                        "effectiveFromDate": "2024-01-01",
                        "effectiveToDate": "2024-09-29",
                        "id": "0aoSG000000sNvhYAE",
				....
				....
                        "insurancePolicyAssets": \[\],
                        "insurancePolicyCoverages": \[\],
                        "insurancePolicyParticipants": \[\],
                        "insurancePolicyParticipantAttributes": \[
                            {
                                "id": "19USG0000004r382AA",
                                "attributeDefinitionId": "0tjSG00000049D8YAI",
                                "attributeName": "DriverAccidents",
                                "attributeValue": "2.0",
                                "insurancePolicyParticipantId": "0aoSG000000sNvhYAE"                            }
                        \],
                        "additionalFields": {}
                    }
                \],
                "insurancePolicyCoverages": \[
                    {
                        "coverageName": "Comprehensive",
                        "id": "0cYSG0000005gt32AA",
                        "insurancePolicyAssetId": "0YWSG0000000N4f4AE",
                        "insurancePolicyId": "0YTSG000000233R4AQ",
                        "name": "IPC-00000034",
				....
				....
                        "insurancePolicyCoverageAttributes": \[
                            {
                                "id": "19VSG0000004r2w2AA",
                                "attributeDefinitionId": "0tjSG00000049DjYAI",
                                "attributeName": "LimitBI",
                                "attributeValue": "100",
                                "insurancePolicyCoverageId": "0cYSG0000005gt32AA"
                            },
				....
				....
                            {
                                "id": "19VSG0000004r342AA",
                                "attributeDefinitionId": "0tjSG00000049DXYAY",
                                "attributeName": "RentalNumDays",
                                "attributeValue": "10",
                                "insurancePolicyCoverageId": "0cYSG0000005gt32AA"
                            } 
                        \],
                        "additionalFields": {}
                    }
                \],
                "insurancePolicyAssetAttributes": \[
                    {
                        "id": "19QSG0000004r2X2AQ",
                        "attributeDefinitionId": "0tjSG00000049E4YAI",
                        "attributeName": "Body Type",
                        "attributeValue": "NA",
                        "insurancePolicyAssetId": "0YWSG0000000N4f4AE"
                    },
			....
			....
                    {
                        "id": "19QSG0000004r2Y2AQ",
                        "attributeDefinitionId": "0tjSG00000049DIYAY",
                        "attributeName": "Alternative Fuel",
                        "attributeValue": "NA",
                        "insurancePolicyAssetId": "0YWSG0000000N4f4AE"
                    }
                \],
                "additionalFields": {}
            }
        \],
        "additionalFields": {}
    }
}

This example shows a sample response for the get policy request with additional fields. The request returns a list of field-set IDs when the operator is $in and a single field-set ID when the operator is $eq.

// GET /connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]=0IXSG000001ADt34AG,0IXSG000001AUqf4AG,0IXSG000001AUp34AG,0IXSG000001AUsH4AW
                                  

{
    "insurancePolicy": {
        "effectiveFromDate": "2024-01-01",
        "effectiveToDate": "2024-09-29",
        ....
        ....
        "insurancePolicyAssets": \[
            {
                "effectiveFromDate": "2024-01-01",
                "effectiveToDate": "2024-09-29",
                "assetName": "Auto Bundle",
                "id": "0YWSG0000000N4f4AE",
                "assetCode": "BMW",
			....
                "insurancePolicyAssets": \[\],
                "insurancePolicyParticipants": \[
                    {
                        "effectiveFromDate": "2024-01-01",
                        "effectiveToDate": "2024-09-29",
                        "id": "0aoSG000000sNvhYAE",
                        "insurancePolicyId": "0YTSG000000233R4AQ",
                        "name": "IPP-00000032",  
				....
				....

                        "insurancePolicyParticipantAttributes": \[\],
                        "additionalFields": {
                            "InsurancePolicyId": "0YTSG000000233R4AQ",
                            "EffectiveFromDate": "2024-01-01",
                            "Id": "0aoSG000000sNvhYAE"
                        },                       
                    }
                \],
                "insurancePolicyCoverages": \[
                    {
                        "coverageName": "Comprehensive",
                        "id": "0cYSG0000005gt32AA",
                        "insurancePolicyAssetId": "0YWSG0000000N4f4AE",
				....

                        },
                        "insurancePolicyCoverageAttributes": \[\],
                        "additionalFields": {
                            "CoverageName": "Comprehensive",
                            "Id": "0cYSG0000005gt32AA"
                        }
                    }
                \],
                "insurancePolicyAssetAttributes": \[\],
                "additionalFields": {
                    "Name": "IPA-00000035"
                } 
            }
        \],
        "additionalFields": {
            "CheckboxField\_\_c": true,
            "EffectiveFromDate": "2024-01-01",
            "Name": "Admin User Policy001"
        }
    }
}

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| contextId | String | ID of the context. | Small, 63.0 | 63.0 |
| error | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 |
| insurancePolicy | Map<String, Object> | Details of insurance policy. | Small, 63.0 | 63.0 |