/persona-identity | Type: Application | PCID required: Yes
Tools
persona_identity_accounts_add_tag
Add tag to an Account 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. |
account-id | string | Yes | — | The account-id value |
meta | object | Yes | — | The meta value |
persona_identity_accounts_list_all_relations
Get all relations for an Account 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. |
account-id | string | Yes | — | The account-id value |
filter | object | Yes | — | The filter value |
persona_identity_accounts_remove_tag
Remove tag from an Account 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. |
account-id | string | Yes | — | The account-id value |
meta | object | Yes | — | The meta value |
persona_identity_accounts_set_all_tags
Set tags on an Account 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. |
account-id | string | Yes | — | The account-id value |
meta | object | Yes | — | The meta value |
persona_identity_approve_an_inquiry
Approve an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | No | — | The meta value |
persona_identity_consolidate_into_an_account
Consolidate Accounts 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. |
account-id | string | Yes | — | Destination Account ID |
meta | object | Yes | — | The meta value |
persona_identity_create_an_account
Create an Account 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_identity_create_an_inquiry
Create an Inquiry 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_identity_create_an_inquiry_session
Create an Inquiry Session 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 |
persona_identity_decline_an_inquiry
Decline an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | No | — | The meta value |
persona_identity_expire_an_inquiry
Expire an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
persona_identity_expire_an_inquiry_session
Expire an Inquiry Session 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. |
inquiry-session-id | string | Yes | — | The inquiry-session-id value |
persona_identity_expire_inquiry_sessions
Expire Inquiry Sessions 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. |
meta | object | No | — | The meta value |
persona_identity_generate_a_one_time_link
Generate a one-time link for an Inquiry 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. |
inquiry-id | string | Yes | — | Inquiry ID (starts with “inq_“) |
meta | object | No | — | The meta value |
persona_identity_generate_a_one_time_link_for_an_inquiry_session
Generate a one-time link for Inquiry Session 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. |
inquiry-session-id | string | Yes | — | The inquiry-session-id value |
persona_identity_inquiries_add_tag
Add tag to an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | No | — | The meta value |
persona_identity_inquiries_perform_simulate_actions
Perform Simulate Actions 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | Yes | — | The meta value |
persona_identity_inquiries_remove_tag
Remove tag from an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | No | — | The meta value |
persona_identity_inquiries_set_all_tags
Set tags on an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
meta | object | No | — | The meta value |
persona_identity_list_all_accounts
List all Accounts 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_identity_list_all_inquiries
List all Inquiries 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_identity_list_all_inquiry_sessions
List all Inquiry Sessions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | No | — | The filter value |
persona_identity_list_all_inquiry_templates
List all Inquiry Templates 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. |
persona_identity_mark_an_inquiry_for_review
Mark an Inquiry for manual review 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
persona_identity_redact_an_account
Redact an Account 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. |
account-id | string | Yes | — | The account-id value |
persona_identity_redact_an_inquiry
Redact an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
persona_identity_resume_an_inquiry
Resume an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
persona_identity_retrieve_an_account
Retrieve an Account 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. |
account-id | string | Yes | — | The account-id value |
persona_identity_retrieve_an_inquiry
Retrieve an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
persona_identity_retrieve_an_inquiry_session
Retrieve an Inquiry Session 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. |
inquiry-session-id | string | Yes | — | Inquiry Session ID |
persona_identity_retrieve_an_inquiry_template
Retrieve an Inquiry Template 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. |
inquiry-template-id | string | Yes | — | Inquiry Template ID |
persona_identity_run_account_action
Run an account action Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account-id | string | Yes | — | The ID of the account to run the action on |
data | object | Yes | — | The data value |
persona_identity_search_accounts
Search Accounts 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_identity_update_an_account
Update an Account 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. |
account-id | string | Yes | — | The account-id value |
data | object | No | — | The data value |
persona_identity_update_an_inquiry
Update an Inquiry 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. |
inquiry-id | string | Yes | — | The inquiry-id value |
data | object | No | — | The data value |

