/persona-cases | Type: Application | PCID required: Yes
Tools
persona_cases_add_persona_objects
Add Persona objects to a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update |
meta | object | No | — | The meta value |
persona_cases_add_tag
Add tag to a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update. |
meta | object | No | — | The meta value |
persona_cases_assign_a_case
Assign a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update |
meta | object | Yes | — | The meta value |
persona_cases_create_a_case
Create a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
data | object | Yes | — | The data value |
meta | object | No | — | The meta value |
persona_cases_create_a_report
Create a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
data | object | No | — | The data value |
meta | object | No | — | The meta value |
persona_cases_create_a_transaction
Create a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
data | object | No | — | The data value |
meta | object | No | — | The meta value |
persona_cases_create_a_transaction_label
Create a Transaction label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to create a label for. |
meta | object | No | — | The meta value |
persona_cases_dismiss_matches
Report Action: Dismiss Matches Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
data | object | Yes | — | The data value |
persona_cases_list_all_cases
List all Cases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | object | No | — | Page number for pagination |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
filter | object | No | — | The filter value |
persona_cases_list_all_reports
List all Reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | object | No | — | Page number for pagination |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
filter | object | No | — | The filter value |
persona_cases_list_all_transactions
List all Transactions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | object | No | — | Page number for pagination |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
filter | object | No | — | The filter value |
persona_cases_list_report_history
List Report history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | object | No | — | Page number for pagination |
report-id | string | Yes | — | The report-id value |
persona_cases_redact_a_case
Redact a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | The case-id value |
persona_cases_redact_a_report
Redact a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
persona_cases_redact_a_transaction
Redact a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | The transaction-id value |
persona_cases_redact_transaction_biometrics
Redact Transaction biometrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | The transaction-id value |
persona_cases_remove_tag
Remove tag from a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update. |
meta | object | No | — | The meta value |
persona_cases_report_action_pause_continuous_monitoring
Report Action: Pause Continuous Monitoring Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
persona_cases_report_action_re_run_report
Report Action: Re-run Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
persona_cases_report_action_resume_continuous_monitoring
Report Action: Resume Continuous Monitoring Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
persona_cases_reports_add_tag
Add tag to a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
meta | object | No | — | The meta value |
persona_cases_reports_remove_tag
Remove tag from a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
meta | object | No | — | The meta value |
persona_cases_reports_set_all_tags
Set tags on a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
meta | object | No | — | The meta value |
persona_cases_retrieve_a_report
Retrieve a Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
report-id | string | Yes | — | The report-id value |
persona_cases_retrieve_a_transaction
Retrieve a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to retrieve. |
persona_cases_retrieve_case
Retrieve a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | The case-id value |
persona_cases_search_cases
Search Cases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
page | object | No | — | Page number for pagination |
query | object | No | — | Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Pass as a JSON object with boolean logic (AND/OR/NOT) and comparison predicates. |
sort | object | No | — | Sort configuration for results |
persona_cases_set_status_for_a_case
Set status on a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update status |
meta | object | No | — | The meta value |
persona_cases_set_tags
Set tags on a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update. |
meta | object | No | — | The meta value |
persona_cases_transactions_add_tag
Add tag to Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to add tag on. |
meta | object | No | — | The meta value |
persona_cases_transactions_remove_tag
Remove tag from a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to remove tag from. |
meta | object | No | — | The meta value |
persona_cases_transactions_set_tags
Sets tags on a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to set tags on. |
meta | object | No | — | The meta value |
persona_cases_update_a_case
Update a Case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
case-id | string | Yes | — | ID of the case to update |
data | object | No | — | The data value |
meta | object | No | — | The meta value |
persona_cases_update_a_transaction
Update a Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details. |
fields | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details. |
transaction-id | string | Yes | — | ID of the transaction to update. |
data | object | No | — | The data value |

