Skip to main content
Server path: /persona-cases | Type: Application | PCID required: Yes

Tools

ToolDescription
persona_cases_add_persona_objectsAdd Persona objects to a Case
persona_cases_add_tagAdd tag to a Case
persona_cases_assign_a_caseAssign a Case
persona_cases_create_a_caseCreate a Case
persona_cases_create_a_reportCreate a Report
persona_cases_create_a_transactionCreate a Transaction
persona_cases_create_a_transaction_labelCreate a Transaction label
persona_cases_dismiss_matchesReport Action: Dismiss Matches
persona_cases_list_all_casesList all Cases
persona_cases_list_all_reportsList all Reports
persona_cases_list_all_transactionsList all Transactions
persona_cases_list_report_historyList Report history
persona_cases_redact_a_caseRedact a Case
persona_cases_redact_a_reportRedact a Report
persona_cases_redact_a_transactionRedact a Transaction
persona_cases_redact_transaction_biometricsRedact Transaction biometrics
persona_cases_remove_tagRemove tag from a Case
persona_cases_report_action_pause_continuous_monitoringReport Action: Pause Continuous Monitoring
persona_cases_report_action_re_run_reportReport Action: Re-run Report
persona_cases_report_action_resume_continuous_monitoringReport Action: Resume Continuous Monitoring
persona_cases_reports_add_tagAdd tag to a Report
persona_cases_reports_remove_tagRemove tag from a Report
persona_cases_reports_set_all_tagsSet tags on a Report
persona_cases_retrieve_a_reportRetrieve a Report
persona_cases_retrieve_a_transactionRetrieve a Transaction
persona_cases_retrieve_caseRetrieve a Case
persona_cases_search_casesSearch Cases
persona_cases_set_status_for_a_caseSet status on a Case
persona_cases_set_tagsSet tags on a Case
persona_cases_transactions_add_tagAdd tag to Transaction
persona_cases_transactions_remove_tagRemove tag from a Transaction
persona_cases_transactions_set_tagsSets tags on a Transaction
persona_cases_update_a_caseUpdate a Case
persona_cases_update_a_transactionUpdate a Transaction

persona_cases_add_persona_objects

Add Persona objects to a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update
metaobjectNoThe meta value

persona_cases_add_tag

Add tag to a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update.
metaobjectNoThe meta value

persona_cases_assign_a_case

Assign a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update
metaobjectYesThe meta value

persona_cases_create_a_case

Create a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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.
dataobjectYesThe data value
metaobjectNoThe meta value

persona_cases_create_a_report

Create a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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.
dataobjectNoThe data value
metaobjectNoThe meta value

persona_cases_create_a_transaction

Create a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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.
dataobjectNoThe data value
metaobjectNoThe meta value

persona_cases_create_a_transaction_label

Create a Transaction label Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to create a label for.
metaobjectNoThe meta value

persona_cases_dismiss_matches

Report Action: Dismiss Matches Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value
dataobjectYesThe data value

persona_cases_list_all_cases

List all Cases Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number for pagination
fieldsobjectNoComma-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.
filterobjectNoThe filter value

persona_cases_list_all_reports

List all Reports Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number for pagination
fieldsobjectNoComma-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.
filterobjectNoThe filter value

persona_cases_list_all_transactions

List all Transactions Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number for pagination
fieldsobjectNoComma-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.
filterobjectNoThe filter value

persona_cases_list_report_history

List Report history Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number for pagination
report-idstringYesThe report-id value

persona_cases_redact_a_case

Redact a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe case-id value

persona_cases_redact_a_report

Redact a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value

persona_cases_redact_a_transaction

Redact a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe transaction-id value

persona_cases_redact_transaction_biometrics

Redact Transaction biometrics Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe transaction-id value

persona_cases_remove_tag

Remove tag from a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update.
metaobjectNoThe meta value

persona_cases_report_action_pause_continuous_monitoring

Report Action: Pause Continuous Monitoring Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value

persona_cases_report_action_re_run_report

Report Action: Re-run Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value

persona_cases_report_action_resume_continuous_monitoring

Report Action: Resume Continuous Monitoring Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value

persona_cases_reports_add_tag

Add tag to a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value
metaobjectNoThe meta value

persona_cases_reports_remove_tag

Remove tag from a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value
metaobjectNoThe meta value

persona_cases_reports_set_all_tags

Set tags on a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value
metaobjectNoThe meta value

persona_cases_retrieve_a_report

Retrieve a Report Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe report-id value

persona_cases_retrieve_a_transaction

Retrieve a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to retrieve.

persona_cases_retrieve_case

Retrieve a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesThe case-id value

persona_cases_search_cases

Search Cases Parameters:
ParameterTypeRequiredDefaultDescription
fieldsobjectNoComma-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.
pageobjectNoPage number for pagination
queryobjectNoSearch 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.
sortobjectNoSort configuration for results

persona_cases_set_status_for_a_case

Set status on a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update status
metaobjectNoThe meta value

persona_cases_set_tags

Set tags on a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update.
metaobjectNoThe meta value

persona_cases_transactions_add_tag

Add tag to Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to add tag on.
metaobjectNoThe meta value

persona_cases_transactions_remove_tag

Remove tag from a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to remove tag from.
metaobjectNoThe meta value

persona_cases_transactions_set_tags

Sets tags on a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to set tags on.
metaobjectNoThe meta value

persona_cases_update_a_case

Update a Case Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the case to update
dataobjectNoThe data value
metaobjectNoThe meta value

persona_cases_update_a_transaction

Update a Transaction Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA 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.
fieldsobjectNoComma-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-idstringYesID of the transaction to update.
dataobjectNoThe data value