Transaction Monitoring

Update case

Changed on

Updates a transaction monitoring case.

patch/v1/transaction_monitoring/cases/{case_token}

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/transaction_monitoring/cases/{case_token}
  • Auth
    API key in header Authorization

Path parameters

case_tokenstring uuid required

Globally unique identifier for the case.

Request body

status'OPEN' | 'ASSIGNED' | 'IN_REVIEW' | 'ESCALATED' | 'RESOLVED' | 'CLOSED'

Status of a case as it progresses through the review workflow:

  • OPEN - The case has been created and is still collecting matching transactions
  • ASSIGNED - An analyst has been assigned and transaction collection has stopped
  • IN_REVIEW - The case is actively being investigated
  • ESCALATED - The case has been reviewed and requires additional oversight
  • RESOLVED - A determination has been made and a resolution recorded
  • CLOSED - The case is finalized
titlestring nullable

New title for the case, or null to clear it

assigneestring nullable

New assignee for the case, or null to unassign

resolutionstring

Resolution to record on the case. Must be one of the allowed_resolutions configured on the case's queue, otherwise the request is rejected with a 400

resolution_notesstring

Notes describing the resolution

tagsobject

Arbitrary key-value metadata to set on the case

priority'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Priority level of a case, controlling queue ordering and SLA urgency

sla_deadlinestring date-time nullable

New SLA deadline for the case, or null to clear it

actor_tokenstring

Optional client-provided identifier for the actor performing this action, recorded on the resulting activity entry. This value is supplied by the client (for example, your own internal user ID) and is not authenticated by Lithic

Response

Case

tokenstring uuid required

Globally unique identifier for the case

titlestring nullable required

Short, human-readable summary of the case

status'OPEN' | 'ASSIGNED' | 'IN_REVIEW' | 'ESCALATED' | 'RESOLVED' | 'CLOSED' required

Status of a case as it progresses through the review workflow:

  • OPEN - The case has been created and is still collecting matching transactions
  • ASSIGNED - An analyst has been assigned and transaction collection has stopped
  • IN_REVIEW - The case is actively being investigated
  • ESCALATED - The case has been reviewed and requires additional oversight
  • RESOLVED - A determination has been made and a resolution recorded
  • CLOSED - The case is finalized
queue_tokenstring uuid required

Token of the queue the case belongs to

priority'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' required

Priority level of a case, controlling queue ordering and SLA urgency

assigneestring nullable required

Identifier of the user the case is currently assigned to

rule_tokenstring uuid nullable required

Token of the transaction monitoring rule that triggered the case

resolutionstring nullable required

Outcome recorded when the case was resolved, from the allowed_resolutions configured on the case's queue

resolution_notesstring nullable required

Free-form notes describing the resolution

sla_deadlinestring date-time nullable required

Deadline by which the case is expected to be resolved

tagsobject required

Arbitrary key-value metadata associated with the case

createdstring date-time required

Date and time at which the case was created

updatedstring date-time required

Date and time at which the case was last updated

resolvedstring date-time nullable required

Date and time at which the case was resolved

collection_stoppedstring date-time nullable required

Date and time at which transaction collection stopped for the case

pending_transactionsboolean required

Whether the case still has transaction scopes pending resolution

Changes

  • f60d86cf70deRevision changes
    • breaking

      the response property // became nullable for the status

    • warning

      added the new FINANCIAL_ACCOUNT enum value to the // response property for the response status

    • warning

      added the new PROGRAM enum value to the // response property for the response status

  • 18a9f9400f22Revision changes
    • breaking

      removed the enum value CONFIRMED_FRAUD of the request property

    • breaking

      removed the enum value ESCALATED_EXTERNAL of the request property

    • breaking

      removed the enum value FALSE_POSITIVE of the request property

    • breaking

      removed the enum value NO_ACTION_REQUIRED of the request property

    • breaking

      removed the enum value SUSPICIOUS_ACTIVITY of the request property

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from no type to string null for status

    • info

      removed subschema #1 from the response property oneOf list for the response status