Fraud Status Management

The TrustX Backoffice and API enable users to manually report a Process Instance as fraud. This guide will demonstrate how to mark individual Process Instances as fraud from the Backoffice UI and the TrustX API.

A fraud report is the investigation of fraud within TrustX. It can reference zero or more Process Instances and a TrustX user can annotate and show where fraud has occurred on a given Process Instance.

Report Fraud in the Backoffice

The Process Instances page of the TrustX Backoffice features a report flag that can be used to report a given Process Instance as fraud. To report a Process Instance as fraud, follow the steps outlined below.

Log in to the Backoffice and navigate to the Process Instances page using the left-side vertical navigation bar.
Use the search filters available to find the Process Instance that will be reported as fraud.
From the Results table, find the Process Instance. Under the actions column, select the 'Report Fraud' flag.
Once selected, a popup modal will appear where the status can be set. An optional note can be added for logging purposes.
The Fraud Status can be set to one of three statuses:
1. Suspected (orange status) - Used when the Process Instance is suspected of fraud.
2. Confirmed (red status) - Used when fraud has been confirmed on the Process Instance.
3. Not Fraudulent (green status) - Use when the Process Instance is not fraudulent.
When fraud has been reported on the Process Instance, the flag will be updated to show the current status. Selecting the report flag will show a pop-up modal of the fraud report.

The fraud status can be updated by selecting the 'Edit Report' button.

Report Fraud via the API

This section will provide a number of examples to set the fraud status of a Process Instance via the TrustX API.

To integrate with the TrustX API, an API key is required for access. The API Keys Guide describes the necessary steps required to generate an API key via the TrustX Backoffice.

Set Fraud Status

Sets the fraud status of a given Process Instance.

Example Request:

POST https://{{tenant}}.{{region}}.trustx.com/api/process-manager/processInstances/{{processInstanceId}}/fraudState Content-Type: application/json Authorization: Bearer {{token}} { "fraudState": "FRAUD_CONFIRMED", "fraudStateNote": "string" //NO_FRAUD_INDICATED //FRAUD_SUSPECTED //FRAUD_CONFIRMED }

Get Fraud Status

This API returns the fraud status of a given Process Instance.

Example Request:

GET https://{{tenant}}.{{region}}.trustx.com/api/process-manager/processInstances/{{processInstanceId}}/fraudState Content-Type: application/json Authorization: Bearer {{token}} {}

Example Response:

{ "fraudState": "FRAUD_CONFIRMED", "fraudStateLastUpdated": "2026-07-23T15:02:26.827Z", "fraudStateLastUpdatedBy": "System", "fraudStateNote": "string" }

Last updated on