Querying for assessment summaries

Use the following endpoints to retrieve assessment summaries associated with a claim:

  • GET /claim/v1/claims/{claimId}/assessment-summaries
  • GET /claim/v1/claims/{claimId}/assessment-summaries/{assessmentSummaryId}

Retrieve a collection of assessment summaries

The first endpoint retrieves a collection of all assessment summaries associated with a claim, along with their details. For example, the following request retrieves all assessment summaries associated with a claim:

Command

GET /claim/v1/claims/demo_sample:1/assessment-summaries

Response

{
    "count": 3,
    "data": [
        {
            "attributes": {
                "category": "low_risk",
                "conclusionCode": "fraud_low",
                "conclusionDescription": "Low likelihood of fraud on this claim",
                "id": "xc:SaueTmhYFGYaZCjRfFZg1",
                "name": "Fraud Risk – Day 0",
                "normalizedScore": "12.0000",
                "rawAssessmentReferenceId": "am-claim-assessment-98765",
                "recommendedActionCode": "no_special_action",
                "recommendedActionDescription": "Process the claim using standard procedures",
                "score": "0.1200",
                "scoreDate": "2024-10-14T15:42:24.000Z",
                "scorePercentile": "10.0000",
                "tapId": "ClaimSegmentationV1",
                "tapSubtypeId": "fraud"
            }
        },
        {
            "attributes": {
                "category": "high_risk",
                "conclusionCode": "fraud_high",
                "conclusionDescription": "High likelihood of fraud",
                "estimate": "10000.0000",
                "id": "xc:SUDbIVpsTNmBblyKluakN",
                "name": "Fraud Risk Model 1",
                "normalizedScore": "87.0000",
                "rawAssessmentReferenceId": "am-claim-assesment-12345",
                "recommendedActionCode": "refer_to_siu",
                "recommendedActionDescription": "Refer claim to SIU",
                "recommendedValue": "10000.0000",
                "score": "0.8700",
                "scoreDate": "2025-10-14T15:42:24.000Z",
                "tapId": "FraudModelV1",
                "tapSubtypeId": "fraud"
            }
        }
    ]
}

When the request is successful, the API responds with all assessment summaries associated with the claim, along with relevant details, like their risk categories, scores, third-party assessment IDs and subIDs (tapId and tapSubtypeId) and recommended actions.

Retrieve an assessment summary by ID

The second endpoint retrieves a specific assessment summary by its id.

If you don't know the ID of the assessment summary you want to retrieve, you can use the first endpoint to get the id. Then you can retrieve the assessment summary by that id. For example, the following request retrieves the high risk assessment summary by its id:

Command

GET /claim/v1/claims/demo_sample:1/assessment-summaries/xc:SUDbIVpsTNmBblyKluakN

Response

{
    "data": {
        "attributes": {
            "category": "high_risk",
            "conclusionCode": "fraud_high",
            "conclusionDescription": "High likelihood of fraud",
            "estimate": "10000.0000",
            "id": "xc:SUDbIVpsTNmBblyKluakN",
            "name": "Fraud Risk Model 1",
            "normalizedScore": "87.0000",
            "rawAssessmentReferenceId": "am-claim-assesment-12345",
            "recommendedActionCode": "refer_to_siu",
            "recommendedActionDescription": "Refer claim to SIU",
            "recommendedValue": "10000.0000",
            "score": "0.8700",
            "scoreDate": "2025-10-14T15:42:24.000Z",
            "tapId": "FraudModelV1",
            "tapSubtypeId": "fraud"
        }
    }
}

The API responds with only the details for the specified assessment summary.