Get Case AI Summary

This endpoint allows you to get a case AI summary.

PUT {{baseurl}}/v2/api/cases/:caseId/summary

Headers

Name	Type	Description
token*	String	API secret token

Parameter

Field	Type	Description
caseId	String	Unique Id of the case

Get AI Summary Sample Request

{
    "task": "Gather evidences, and add them to the case.",
    "isCompleted": true
}

Success Response

{
        "success": true,
        "statusCode": 200,
        "message": "Case summary retrieved successfully!",
        "data": {
            "report": {
                "executive_summary": "The case involves a significant KYC data mismatch between the client's NIN and BVN, indicating potential identity issues. The severity is classified as high due to the discrepancies in identification data. It is recommended to file a SAR to address the potential risks associated with this entity.",
                "entity_profile": {
                    "name": "",
                    "registration_location": "",
                    "industry": "",
                    "account_opening_date": "",
                    "expected_annual_volume": "",
                    "risk_indicators": [
                        {
                            "label": "KYC Data Mismatch",
                            "level": "high"
                        }
                    ],
                    "key_findings": [
                        "Complete mismatch between NIN and BVN data."
                    ]
                },
                "transaction_analysis": {
                    "total_volume_usd": 0,
                    "transaction_count": 0,
                    "average_transaction_size_usd": 0,
                    "investigation_period_days": 0,
                    "baseline_comparison_pct": 0,
                    "pattern_indicators": [],
                    "suspicious_activity_indicators": []
                },
                "suspicious_activity_determination": "The identified KYC data mismatch raises concerns about the legitimacy of the client's identity, which is consistent with known money laundering typologies that involve identity fraud.",
                "recommended_action": "SAR Filing"
            }
        },
        "links": []
    }

Error Response

HTTP/1.1 404 NotFound
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}