Perform an action within case context

Perform an action on an existing case.

This endpoint allows you to:

  • Add comments to a case
  • Attach supporting documents with comment action
  • Submit an override request for a case
  • Accept, refuse, or cancel an override request
  • Close a case
  • Record a callback phone and trigger its phone analysis

Each action will create a permanent record in the case's action log
and may change the case's status.

Required permissions:

  • cases_write

Action Type Permissions:

  • comment: Available to contributors and reviewers
  • accept: Available to reviewers only (not the override creator)
  • refuse: Available to reviewers only (not the override creator)
  • cancel: Available only to the override creator
  • trigger_phone_analysis: Available to users with the pair role (Company Account Audit case) or the quarantine check write role (Company Account Check case)

Important constraints:

  • The cases feature must be enabled for your account
  • Actions can only be performed on cases in appropriate states
  • Users must have proper roles to perform specific actions

Trigger phone analysis:

The trigger_phone_analysis action records the callback phone number and its source on the case,
and starts the phone analysis of that number, in one call. Read the result with
GET /api/v1/cases/{case_id}/phone_analyses, or wait for the complete_phone_analysis case action.

It needs the phone analysis feature on your account, and a callback step on the case.
The callback step is part of the case's investigation checklist, which is set once, when the case is created:

  • Only cases whose evaluation was unevaluated when the case was created get a callback step.
    Cases created from any other evaluation state (unfavorable, anomaly, ...) never have one.
  • Your workspace can switch the callback step off in its unevaluated checklist settings.
    Cases created while it is off have no callback step.
  • Changing the checklist settings does not add or remove the step on existing cases.

On a case without a callback step, the action returns 422 with the callback_step_missing code,
and records nothing.

The action also returns 422 when:

  • phone is not in E.164 format (invalid_phone)
  • source is other and source_details is missing (blank)
  • the case is closed (case_closed) or its callback step is completed (callback_step_completed)
  • the case already has a pending or successful phone analysis (analysis_limit_reached).
    After a failed analysis, you can trigger a new one, with a new phone number if needed.
  • a pending or successful analysis exists and phone is a different number (callback_phone_locked)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the case on which to perform the action.
Must be a valid UUID format.

Query Params
string
enum

Comma-separated list of related resources to include in the response.

Supported values:

  • user - The user who performed the action
  • comment - The comment which was created
  • comment.documents - Supporting documents attached to the comment
  • override - The override which was created
  • override.assigned_reviewers - Supporting reviewers attached to the override
  • phone_analysis - The phone analysis which was triggered

Including related resources reduces the need for additional API calls.

Body Params

The case action request payload

Root object containing the case action data

data
object
required

Container for case action data following JSON:API specification

Headers
string
enum

Specifies the preferred language for the response. Supported languages:

  • en - English
  • fr - French

If not provided, the default language will be used.

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json