Skip to main content
PATCH
Change a case’s title, priority, due date, tags or owning review team. Send only the fields you want to change; the fields you omit keep their value. tags replaces the whole tag list, so send every tag the case should keep.

Change the owning team

Set team to the uuid of an active review team of this application, or to null to clear it. To find a team’s uuid, call GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/ and read results[].uuid. A team that is inactive, deleted, or belongs to another application returns 400 with {"team": ["Choose an active team of this application."]}. Each change adds a TEAM_CHANGED event to the case timeline with the previous and new team. Changing the team does not change who the case is assigned to.

Timeline events

A change to the priority, due date, tags or team adds a PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED or TEAM_CHANGED event to the case timeline. A title change is saved without a timeline event. Sending a field with its current value adds no event.

Access

Cases endpoints need a full-access API key. A key with restricted access receives 403. A console member token needs write:cases.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID.

case_uuid
string<uuid>
required

Case UUID.

Example:

"c1a5e000-0000-4000-8000-000000000001"

Body

application/json
title
string

New case title.

Maximum string length: 255
priority
enum<string>
Available options:
LOW,
MEDIUM,
HIGH
due_at
string<date-time> | null

New deadline. Send null to clear it.

tags
string[]

The complete tag list. It replaces the current tags.

team
string<uuid> | null

UUID of the review team that owns the case. It must be an active team of this application. Send null to clear the team.

Response

Updated case.

uuid
string<uuid>
case_number
string | null
title
string
status
enum<string>
Available options:
OPEN,
AWAITING_USER,
RESOLVED
resolution
enum<string> | null
Available options:
FALSE_POSITIVE,
VALID_THREAT,
INCONCLUSIVE,
REQUIREMENTS_NOT_MET,
REQUIREMENTS_SATISFIED
resolution_notes
string | null
priority
enum<string>
Available options:
LOW,
MEDIUM,
HIGH
source
enum<string>
Available options:
MANUAL,
AML_SCREENING,
TRANSACTION_RULE,
WORKFLOW_BUILDER
tags
string[]
subject
object | null

The single user or business the case is anchored to.

assigned_to
object | null
assigned_at
string<date-time> | null
team
object | null

The review team that owns the case, or null when no team owns it. Routing sets it when a routing rule places the case with one of its teams. Change or clear it with PATCH .../cases/{case_uuid}/ (team).

due_at
string<date-time> | null
resolved_at
string<date-time> | null
resolved_by_email
string | null
pending_resolution
object | null

Set only while a 4-eyes resolution is staged on the checker blueprint, awaiting approve or reject-approval.

checker
object | null

The member named to approve or reject the pending resolution. Set only while a four-eyes resolution waits on a named checker. Null when nothing is pending, while the pending resolution waits on the checker queue, and once the resolution is approved, rejected, or returned for a new review because the evidence changed.

metadata
object
blueprint
object
notes
object[]

Newest 50 notes.

events
object[]

Newest 100 events.

notes_count
integer
checklist_items
object[]
created_at
string<date-time>
updated_at
string<date-time>