Querying for and modifying exposures
Use the following endpoints to query for a claim's exposures:
- GET
/claim/v1/claims/{claimId}/exposures - GET
/claim/v1/claims/{claimId}/exposures/{exposureId}
The first request retrieves a collection of exposures associated with a claim, including each
exposure's id. The second request retrieves a specific exposure by that
id.
Query for collection of exposures
Use the following endpoint to query for a collection of exposures associated with a claim:
- GET
/claim/v1/claims/{claimId}/exposures
The following request retrieves all the exposures associated with claim
demo_sample:ce1:
Command
GET /claim/v1/claims/demo_sample:ce1/exposuresResponse
{
"count": 2,
"data": [
{
"attributes": {
"assignedGroup": {
"displayName": "Auto1 - TeamA",
"id": "demo_sample:123",
"type": "Group",
"uri": "/admin/v1/groups/demo_sample:123"
},
"assignedUser": {
"displayName": "Andy Applegate",
"id": "demo_sample:456",
"type": "User",
"uri": "/admin/v1/users/demo_sample:456"
},
"assignmentStatus": {
"code": "assigned",
"name": "Assigned"
},
"claimOrder": 1,
"claimant": {
"displayName": "Albert Albertson",
"id": "xc:SzoNoIuElKbbWVe_B2sQm",
"type": "ClaimContact",
"uri": "/claim/v1/claims/demo_sample:ce1/contacts/xc:SzoNoIuElKbbWVe_B2sQm"
},
"claimantType": {
"code": "insured",
"name": "Insured"
},
"contactPermitted": true,
"coverageSubtype": {
"code": "PACollisionCov",
"name": "Collision"
},
"createTime": "2025-10-03T02:25:22.505Z",
"id": "demo_sample:ee1",
"jurisdiction": {
"code": "CA",
"name": "California"
},
"lossParty": {
"code": "insured",
"name": "Insured's loss"
},
"otherCoverage": false,
"primaryCoverage": {
"code": "PACollisionCov",
"name": "Collision"
},
"progress": {
"code": "investigation",
"name": "Investigation"
},
"segment": {
"code": "auto_low",
"name": "Auto - low complexity"
},
"state": {
"code": "open",
"name": "Open"
},
"strategy": {
"code": "auto_fast",
"name": "Auto - Fast Track"
},
"tier": {
"code": "1p_pd_low",
"name": "1st Party Physical Damage - Low Complexity"
},
"type": {
"code": "VehicleDamage",
"name": "Vehicle"
},
"vehicleIncident": {
"displayName": "1997 Saturn SL (1HGJ465 / California)",
"id": "xc:SCXAd7bWKQrz79E8vRN7y",
"type": "VehicleIncident",
"uri": "/claim/v1/claims/demo_sample:ce1/vehicle-incidents/xc:SCXAd7bWKQrz79E8vRN7y"
}
}
},
{
"attributes": {
"assignedGroup": {
"displayName": "Auto1 - TeamA",
"id": "demo_sample:123",
"type": "Group",
"uri": "/admin/v1/groups/demo_sample:123"
},
"assignedUser": {
"displayName": "Andy Applegate",
"id": "demo_sample:1",
"type": "User",
"uri": "/admin/v1/users/demo_sample:456"
},
"assignmentStatus": {
"code": "assigned",
"name": "Assigned"
},
"claimOrder": 2,
"claimant": {
"displayName": "Robert Robertson",
"id": "xc:Srtg7DTdRpyBJYPkdTWjO",
"type": "ClaimContact",
"uri": "/claim/v1/claims/demo_sample:ce1/contacts/xc:Srtg7DTdRpyBJYPkdTWjO"
},
"claimantType": {
"code": "householdmember",
"name": "Member of the insured's household"
},
"contactPermitted": true,
"coverageSubtype": {
"code": "PAMedPayCov",
"name": "Medical Payments"
},
"createTime": "2025-10-03T02:25:22.505Z",
"id": "demo_sample:ee2",
"injuryIncident": {
"displayName": "Minor Fracture",
"id": "xc:S3aS6h1D96kWUTCS-BRTy",
"type": "InjuryIncident",
"uri": "/claim/v1/claims/demo_sample:ce1/injury-incidents/xc:S3aS6h1D96kWUTCS-BRTy"
},
"jurisdiction": {
"code": "CA",
"name": "California"
},
"lossParty": {
"code": "insured",
"name": "Insured's loss"
},
"otherCoverage": false,
"primaryCoverage": {
"code": "PAMedPayCov",
"name": "Medical Payments"
},
"progress": {
"code": "investigation",
"name": "Investigation"
},
"segment": {
"code": "injury_low",
"name": "Injury - low complexity"
},
"state": {
"code": "open",
"name": "Open"
},
"strategy": {
"code": "injury_fast",
"name": "Injury - Fast Track"
},
"tier": {
"code": "1p_med_low",
"name": "1st Party Medical - Low Complexity"
},
"type": {
"code": "MedPay",
"name": "Med Pay"
}
}
]
}
The response lists each exposure associated with the claim
demo_sample:ce1, including the exposure's information and
id, which you can use to query for that specific exposure.
Query for specific exposure
If you have an exposure's id, you can query for the specific exposure by
that id. You can use the earlier request to find the exposure's
id by querying for the collection that includes it.
For example, the following request queries for the exposure
demo_sample:ee1:
Command
GET /claims/v1/claim/demo_sample:ce1/exposures/demo_sample:ee1Request
{
"data": {
"attributes": {
"assignedGroup": {
"displayName": "Auto1 - TeamA",
"id": "demo_sample:123",
"type": "Group",
"uri": "/admin/v1/groups/demo_sample:31"
},
"assignedUser": {
"displayName": "Andy Applegate",
"id": "demo_sample:456",
"type": "User",
"uri": "/admin/v1/users/demo_sample:1"
},
"assignmentStatus": {
"code": "assigned",
"name": "Assigned"
},
"claimOrder": 1,
"claimant": {
"displayName": "Albert Albertson",
"id": "xc:SzoNoIuElKbbWVe_B2sQm",
"type": "ClaimContact",
"uri": "/claim/v1/claims/demo_sample:ce1/contacts/xc:SzoNoIuElKbbWVe_B2sQm"
},
"claimantType": {
"code": "insured",
"name": "Insured"
},
"contactPermitted": true,
"coverageSubtype": {
"code": "PACollisionCov",
"name": "Collision"
},
"createTime": "2025-10-03T02:25:22.505Z",
"id": "demo_sample:ee1",
"jurisdiction": {
"code": "CA",
"name": "California"
},
"lossParty": {
"code": "insured",
"name": "Insured's loss"
},
"otherCoverage": false,
"primaryCoverage": {
"code": "PACollisionCov",
"name": "Collision"
},
"progress": {
"code": "investigation",
"name": "Investigation"
},
"segment": {
"code": "auto_low",
"name": "Auto - low complexity"
},
"state": {
"code": "open",
"name": "Open"
},
"strategy": {
"code": "auto_fast",
"name": "Auto - Fast Track"
},
"tier": {
"code": "1p_pd_low",
"name": "1st Party Physical Damage - Low Complexity"
},
"type": {
"code": "VehicleDamage",
"name": "Vehicle"
},
"validationLevel": {
"code": "payment",
"name": "Ability to pay"
},
"vehicleIncident": {
"displayName": "1997 Saturn SL (1HGJ465 / California)",
"id": "xc:SCXAd7bWKQrz79E8vRN7y",
"type": "VehicleIncident",
"uri": "/claim/v1/claims/demo_sample:ce1/vehicle-incidents/xc:SCXAd7bWKQrz79E8vRN7y"
}
}
}
}
Filtered query for collection of exposures
You can apply the following filters to the exposures to limit your results:
assignedUserassignedUsernameexternalStatusprimaryCoverage
To learn more about filtering queries, refer to The filter query parameter.
For example, the following request queries for a collection of exposures associated with
claim demo_sample:ce1, but it has a primaryCoverage filter
applied, limiting the results to only exposures associated with the specified coverage:
Command
GET /claims/v1/claim/demo_sample:ce1/exposures/?filter=primaryCoverage:eq:PAMedPayCovResponse
{
"count": 1,
"data": [
{
"attributes": {
"assignedGroup": {
"displayName": "Auto1 - TeamA",
"id": "demo_sample:123",
"type": "Group",
"uri": "/admin/v1/groups/demo_sample:123"
},
"assignedUser": {
"displayName": "Andy Applegate",
"id": "demo_sample:456",
"type": "User",
"uri": "/admin/v1/users/demo_sample:456"
},
"assignmentStatus": {
"code": "assigned",
"name": "Assigned"
},
"claimOrder": 2,
"claimant": {
"displayName": "Robert Robertson",
"id": "xc:Srtg7DTdRpyBJYPkdTWjO",
"type": "ClaimContact",
"uri": "/claim/v1/claims/demo_sample:ce1/contacts/xc:Srtg7DTdRpyBJYPkdTWjO"
},
"claimantType": {
"code": "householdmember",
"name": "Member of the insured's household"
},
"contactPermitted": true,
"coverageSubtype": {
"code": "PAMedPayCov",
"name": "Medical Payments"
},
"createTime": "2025-10-03T02:25:22.505Z",
"id": "demo_sample:ee2",
"injuryIncident": {
"displayName": "Minor Fracture",
"id": "xc:S3aS6h1D96kWUTCS-BRTy",
"type": "InjuryIncident",
"uri": "/claim/v1/claims/demo_sample:ce1/injury-incidents/xc:S3aS6h1D96kWUTCS-BRTy"
},
"jurisdiction": {
"code": "CA",
"name": "California"
},
"lossParty": {
"code": "insured",
"name": "Insured's loss"
},
"otherCoverage": false,
"primaryCoverage": {
"code": "PAMedPayCov",
"name": "Medical Payments"
},
"progress": {
"code": "investigation",
"name": "Investigation"
},
"segment": {
"code": "injury_low",
"name": "Injury - low complexity"
},
"state": {
"code": "open",
"name": "Open"
},
"strategy": {
"code": "injury_fast",
"name": "Injury - Fast Track"
},
"tier": {
"code": "1p_med_low",
"name": "1st Party Medical - Low Complexity"
},
"type": {
"code": "MedPay",
"name": "Med Pay"
}
}
}
]
}
The response includes the only exposure associated with the
primaryCoverage of PAMedPayCov:
demo_sample:ee2.
Modify exposure
Use the following endpoint to modify an existing exposure:
- PATCH
/claims/v1/claim/{claimId}/exposures/{exposureId}
For example, the following request updates the contactPermitted field for
the claimant associated with the exposure demo_sample:ee1:
Command
PATCH /claim/v1/claims/demo_sample:ce1/exposures/demo_sample:ee1Request
{
"data": {
"attributes": {
"contactPermitted": false
}
}
}
Response
{
"data": {
"attributes": {
"assignedGroup": {
"displayName": "Auto1 - TeamA",
"id": "demo_sample:31",
"type": "Group",
"uri": "/admin/v1/groups/demo_sample:123"
},
"assignedUser": {
"displayName": "Andy Applegate",
"id": "demo_sample:1",
"type": "User",
"uri": "/admin/v1/users/demo_sample:456"
},
"assignmentStatus": {
"code": "assigned",
"name": "Assigned"
},
"claimOrder": 1,
"claimant": {
"displayName": "Albert Albertson",
"id": "xc:SzoNoIuElKbbWVe_B2sQm",
"type": "ClaimContact",
"uri": "/claim/v1/claims/demo_sample:ce1/contacts/xc:SzoNoIuElKbbWVe_B2sQm"
},
"claimantType": {
"code": "insured",
"name": "Insured"
},
"contactPermitted": false,
"coverageSubtype": {
"code": "PACollisionCov",
"name": "Collision"
},
"createTime": "2025-10-03T02:25:22.505Z",
"id": "demo_sample:ee1",
"jurisdiction": {
"code": "CA",
"name": "California"
},
"lossParty": {
"code": "insured",
"name": "Insured's loss"
},
"otherCoverage": false,
"primaryCoverage": {
"code": "PACollisionCov",
"name": "Collision"
},
"progress": {
"code": "investigation",
"name": "Investigation"
},
"segment": {
"code": "auto_low",
"name": "Auto - low complexity"
},
"state": {
"code": "open",
"name": "Open"
},
"strategy": {
"code": "auto_fast",
"name": "Auto - Fast Track"
},
"tier": {
"code": "1p_pd_low",
"name": "1st Party Physical Damage - Low Complexity"
},
"type": {
"code": "VehicleDamage",
"name": "Vehicle"
},
"validationLevel": {
"code": "payment",
"name": "Ability to pay"
},
"vehicleIncident": {
"displayName": "1997 Saturn SL (1HGJ465 / California)",
"id": "xc:SCXAd7bWKQrz79E8vRN7y",
"type": "VehicleIncident",
"uri": "/claim/v1/claims/demo_sample:ce1/vehicle-incidents/xc:SCXAd7bWKQrz79E8vRN7y"
}
}
}
}
The response provides the updated exposure. The claimant cannot be contacted anymore
because the contactPermitted field is now "false".
There are a number of fields that are read-only and cannot be modified with a PATCH
request. You can use the GET common/v1/entity-schemas/Exposures request to
determine which fields you can potentially modify. Then, if you attempt to modify a field
and get an error message, you can use the error messaging to determine what changes to make
to your request.