Create a Case

This endpoint allows you to create a case.

POST {{baseurl}}/v2/api/cases

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Field	Type	Description
caseTitle*	String	Title of the case
caseType*	String	Type of case being created
description*	String	Detailed reason or context for creating the case
severity*	String	Severity level of the case Allowed values: "High", "Medium", "Low"
entityId*	String	ID of the entity the case is associated with
linkedIssues*	Object[]	List of issues linked to this case
issueId*	String	ID of the linked issue
issueType*	String	Type of the linked issue (e.g., Activity, Alert, BehaviouralInsight, Custom)
status	String	Optional status for the linked issue
caseStage*	Object	Current stage of the case
stage*	String	Stage name (e.g., Investigation, Review)
level*	String|Number	Level or priority of the stage (e.g., LV1, 1, etc.)
tasks*	Object[]	List of tasks assigned for the stage
task*	String	Task description
Investigator*	Object	Information about the investigator assigned to the case
investigatorId*	String	ID of the investigator

Create a Case Sample Request

{
            "caseTitle": "KYC data Mismatch",
            "caseType": "KYC",
            "description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
            "severity": "High",
            "entityId": "6880a452495dce07d2f7ff5a",
            "investigator": {
                "investigatorId": "681d7b32cd275833cb856fff",
            },
            "linkedIssues": [
                {
                    "issueId": "6880f7d527309cf76eb5db2e",
                    "issueType": "Activity",
                    "status": "Mismatch"
                }
            ],
            "caseStage": [
                {
                    "stage": "Investigation",
                    "level": "LV1",
                    "tasks": [
                        {
                            "task": "Investigate KYC verification"
                        },
                        {
                            "task": "Gather evidences, and add them to the case."
                        },
                        {
                            "task": "Confirm if entities are same and why there's a mismatch"
                        }
                    ]
                },
                {
                    "stage": "Analysis",
                    "level": "LV2",
                    "tasks": [
                        {
                            "task": "Gather evidences"
                        },
                        {
                            "task": "Analyse evidences"
                        },
                        {
                            "task": "Review analysis"
                        }
                    ]
                },
                {
                    "stage": "Filing",
                    "level": "LV3",
                    "tasks": [
                        {
                            "task": "File report"
                        },
                        {
                            "task": "Follow up filing"
                        },
                        {
                            "task": "Confirm case filed successfully"
                        }
                    ]
                }
            ]
}

Success Response

{
        "success": true,
        "statusCode": 201,
        "message": "Case created successfully!",
        "data": {
            "caseTitle": "KYC data Mismatch",
            "status": "Opened",
            "caseType": "KYC",
            "severity": "High",
            "parentId": null,
            "businessId": "681d7b30cd275833cb856ff8",
            "entityId": "6880a452495dce07d2f7ff5a",
            "description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
            "evidences": [],
            "linkedIssues": [
                {
                    "issueId": "6880f7d527309cf76eb5db2e",
                    "issueType": "Activity",
                    "dateLinked": null,
                    "status": "Mismatch"
                },
                {
                    "issueId": "6880f7d527309cf76eb5db2e",
                    "issueType": "Transaction",
                    "dateLinked": null,
                    "status": "Mismatch"
                },
                {
                    "issueId": "6880f7d527309cf76eb5db2e",
                    "issueType": "Alert",
                    "dateLinked": null,
                    "status": "Mismatch"
                }
            ],
            "caseStage": [
                {
                    "stage": "Investigation",
                    "level": "LV1",
                    "investigatorId": "681d7b32cd275833cb856fff",
                    "investigatorName": "Jaymee Bottomore",
                    "notes": [],
                    "isReassigned": false,
                    "previousInvestigators": [],
                    "tasks": [
                        {
                            "task": "Investigate KYC verification",
                            "isCompleted": false
                        },
                        {
                            "task": "Gather evidences, and add them to the case.",
                            "isCompleted": false
                        },
                        {
                            "task": "Confirm if entities are same and why there's a mismatch",
                            "isCompleted": false
                        }
                    ],
                    "_id": "68945a37a52eb93b87f827fa"
                }
            ],
            "activities": [
                {
                    "event": "Case Created",
                    "activity": "Case created by Jaymee Bottomore",
                    "createdBy": "Jaymee Bottomore",
                    "userId": "681d7b30cd275833cb856ff8",
                    "eventDateTime": "2025-08-07T07:48:07.145Z",
                    "_id": "68945a37a52eb93b87f827fb"
                }
            ],
            "isDeleted": false,
            "comments": [],
            "createdAt": "2025-08-07T07:48:07.165Z",
            "lastModifiedAt": "2025-08-07T07:48:07.165Z",
            "_createdAt": "2025-08-07T08:48:077+01:00",
            "_lastModifiedAt": "2025-08-07T08:48:077+01:00",
            "object": "case",
            "id": "cas_68945a37a52eb93b87f827f9"
        },
        "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": {}
}