Skip to main content
Create Case
The assignedTo field must be a valid user ID from your Sigma account. You can find user IDs under Account → Team Members & Roles in the dashboard. The user must have the can assign case permission to be assigned a case.

Authorizations

apiKey
string
header
required
apiSecret
string
header
required

Body

application/json
title
string
required

A short, descriptive title for the case. Shown in the case list.

Example:

"High-value transaction requiring review"

description
string
required

A detailed description of why the case was opened and what needs to be investigated.

Example:

"A transfer of ₦4,500,000 was flagged by the fraud scoring engine with a score of 87. The customer has no prior history of transactions of this size. Requires manual review before release."

priority
enum<string>
required

The urgency level of the case.

Available options:
low,
medium,
high
Example:

"high"

assignedTo
string
required

The ID of the team member responsible for this case. Must be a valid user in your Sigma account with the can assign case permission.

Example:

"64a9f1c2d3e4b5a6c7d8e9f0"

module
enum<string>

The Sigma product area this case relates to. Use one of the standard module values or omit and provide customModule instead.

Available options:
transaction-monitoring,
aml,
cdd,
kyc,
reporting
Example:

"transaction-monitoring"

customModule
string

A custom module name for cases that do not fit a standard Sigma product module. Provide either module or customModule, not both.

Example:

"internal-audit"

record
object

A reference to an existing Sigma record to link to this case.

dueDate
string<date-time> | null

The deadline for resolving this case. ISO 8601 format. Cases past their due date are flagged as overdue in analytics.

Example:

"2026-04-25T23:59:59.000Z"

tasks
string[]

An optional checklist of steps the investigator should complete. Each string becomes a task item on the case.

Example:
attachments
string[]

File paths for any attachments to include with the case at creation.

Example:
escalateTo
string | null

The ID of a senior team member to escalate this case to, if needed.

Example:

null

Response

Case created successfully

message
string
Example:

"Case created successfully"

data
object