POST /v1/cases— Create a new fraud investigation caseGET /v1/cases/{id}— Retrieve a case by ID
POST /v1/cases
Create a new case to begin tracking a fraud investigation. You can link transactions and a user at creation time, or add them later viaPATCH /v1/cases/{id}.
Request Body
string
required
A short, descriptive title for the case. Keep it specific enough for your
team to identify the investigation at a glance. Example:
"Card testing attack — June 14 checkout endpoint".string
required
The category of fraud this investigation covers. Accepted values:
payment_fraud— Unauthorized or fraudulent payment transactionsaccount_takeover— Unauthorized access to a legitimate user accountidentity_fraud— Synthetic, stolen, or fabricated identity usechargeback— Investigation linked to a disputed transactionpolicy_violation— Abuse of promotions, referrals, or platform policies
array
An array of transaction ID strings to link to this case at creation time.
You can link additional transactions later via
PATCH /v1/cases/{id}.string
The ID of the user this investigation primarily concerns. Linking a user
gives your team direct access to that user’s event history from within the
case record.
string
default:"medium"
The severity level of this investigation. Accepted values:
low, medium,
high, critical. Severity affects prioritization in your case queue but
does not influence FraudEG’s detection engine.string
Initial analyst notes to attach to the case at creation. These are recorded
as the first entry in the case’s
events audit log with action note_added.string
Your internal analyst ID to assign the case to. The assignee receives a
case.updated webhook event when the case is created.GET /v1/cases/
Retrieve the full record for an existing case, including its current status, all linked transactions, and the complete audit log of case activity.Path Parameters
string
required
The case ID returned in the
case_id field when you created the case via
POST /v1/cases.Response Fields
string
Unique identifier for this case. Stable and globally unique across your
account.
string
The short descriptive title set when the case was created.
string
The fraud investigation category. See
case_type in the POST request body
for the full list of values.string
Current lifecycle status of the case:
open— Investigation has not startedin_review— Actively being investigatedresolved— Investigation complete with a findingclosed— Case closed without a finding or further action
string
The severity level assigned to this case:
low, medium, high, or
critical.array
Array of transaction ID strings linked to this case.
string | null
The user ID linked to this case, or
null if no user is associated.array
Append-only audit log of all activity on this case, ordered chronologically.
string
ISO 8601 timestamp recording when this case was created.
string
ISO 8601 timestamp of the most recent update to this case.
Updating a Case
UsePATCH /v1/cases/{id} to update an existing case. You can change the status, append analyst notes, reassign the case, or link additional transactions. Each change is recorded as a new entry in the case’s events audit log.
Examples
GET Response
Subscribe to the
case.updated webhook event to receive real-time
notifications whenever a case status changes, a note is added, or the case is
reassigned. This lets you trigger downstream workflows — such as notifying an
analyst via your internal tooling or updating a linked ticket in your issue
tracker — without polling the API.