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

Tools

ToolDescription
persona_identity_accounts_add_tagAdd tag to an Account
persona_identity_accounts_list_all_relationsGet all relations for an Account
persona_identity_accounts_remove_tagRemove tag from an Account
persona_identity_accounts_set_all_tagsSet tags on an Account
persona_identity_approve_an_inquiryApprove an Inquiry
persona_identity_consolidate_into_an_accountConsolidate Accounts
persona_identity_create_an_accountCreate an Account
persona_identity_create_an_inquiryCreate an Inquiry
persona_identity_create_an_inquiry_sessionCreate an Inquiry Session
persona_identity_decline_an_inquiryDecline an Inquiry
persona_identity_expire_an_inquiryExpire an Inquiry
persona_identity_expire_an_inquiry_sessionExpire an Inquiry Session
persona_identity_expire_inquiry_sessionsExpire Inquiry Sessions
persona_identity_generate_a_one_time_linkGenerate a one-time link for an Inquiry
persona_identity_generate_a_one_time_link_for_an_inquiry_sessionGenerate a one-time link for Inquiry Session
persona_identity_inquiries_add_tagAdd tag to an Inquiry
persona_identity_inquiries_perform_simulate_actionsPerform Simulate Actions
persona_identity_inquiries_remove_tagRemove tag from an Inquiry
persona_identity_inquiries_set_all_tagsSet tags on an Inquiry
persona_identity_list_all_accountsList all Accounts
persona_identity_list_all_inquiriesList all Inquiries
persona_identity_list_all_inquiry_sessionsList all Inquiry Sessions
persona_identity_list_all_inquiry_templatesList all Inquiry Templates
persona_identity_mark_an_inquiry_for_reviewMark an Inquiry for manual review
persona_identity_redact_an_accountRedact an Account
persona_identity_redact_an_inquiryRedact an Inquiry
persona_identity_resume_an_inquiryResume an Inquiry
persona_identity_retrieve_an_accountRetrieve an Account
persona_identity_retrieve_an_inquiryRetrieve an Inquiry
persona_identity_retrieve_an_inquiry_sessionRetrieve an Inquiry Session
persona_identity_retrieve_an_inquiry_templateRetrieve an Inquiry Template
persona_identity_run_account_actionRun an account action
persona_identity_search_accountsSearch Accounts
persona_identity_update_an_accountUpdate an Account
persona_identity_update_an_inquiryUpdate an Inquiry

persona_identity_accounts_add_tag

Add tag to an Account 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.
account-idstringYesThe account-id value
metaobjectYesThe meta value

persona_identity_accounts_list_all_relations

Get all relations for an Account 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.
account-idstringYesThe account-id value
filterobjectYesThe filter value

persona_identity_accounts_remove_tag

Remove tag from an Account 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.
account-idstringYesThe account-id value
metaobjectYesThe meta value

persona_identity_accounts_set_all_tags

Set tags on an Account 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.
account-idstringYesThe account-id value
metaobjectYesThe meta value

persona_identity_approve_an_inquiry

Approve an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
metaobjectNoThe meta value

persona_identity_consolidate_into_an_account

Consolidate Accounts 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.
account-idstringYesDestination Account ID
metaobjectYesThe meta value

persona_identity_create_an_account

Create an Account 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_identity_create_an_inquiry

Create an Inquiry 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_identity_create_an_inquiry_session

Create an Inquiry Session 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

persona_identity_decline_an_inquiry

Decline an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
metaobjectNoThe meta value

persona_identity_expire_an_inquiry

Expire an Inquiry 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.
inquiry-idstringYesThe inquiry-id value

persona_identity_expire_an_inquiry_session

Expire an Inquiry Session 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.
inquiry-session-idstringYesThe inquiry-session-id value

persona_identity_expire_inquiry_sessions

Expire Inquiry Sessions 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.
metaobjectNoThe meta value

Generate a one-time link for an Inquiry 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.
inquiry-idstringYesInquiry ID (starts with “inq_“)
metaobjectNoThe meta value

Generate a one-time link for Inquiry Session 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.
inquiry-session-idstringYesThe inquiry-session-id value

persona_identity_inquiries_add_tag

Add tag to an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
metaobjectNoThe meta value

persona_identity_inquiries_perform_simulate_actions

Perform Simulate Actions 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.
inquiry-idstringYesThe inquiry-id value
metaobjectYesThe meta value

persona_identity_inquiries_remove_tag

Remove tag from an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
metaobjectNoThe meta value

persona_identity_inquiries_set_all_tags

Set tags on an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
metaobjectNoThe meta value

persona_identity_list_all_accounts

List all Accounts 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_identity_list_all_inquiries

List all Inquiries 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_identity_list_all_inquiry_sessions

List all Inquiry Sessions Parameters:
ParameterTypeRequiredDefaultDescription
filterobjectNoThe filter value

persona_identity_list_all_inquiry_templates

List all Inquiry Templates 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.

persona_identity_mark_an_inquiry_for_review

Mark an Inquiry for manual review 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.
inquiry-idstringYesThe inquiry-id value

persona_identity_redact_an_account

Redact an Account 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.
account-idstringYesThe account-id value

persona_identity_redact_an_inquiry

Redact an Inquiry 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.
inquiry-idstringYesThe inquiry-id value

persona_identity_resume_an_inquiry

Resume an Inquiry 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.
inquiry-idstringYesThe inquiry-id value

persona_identity_retrieve_an_account

Retrieve an Account 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.
account-idstringYesThe account-id value

persona_identity_retrieve_an_inquiry

Retrieve an Inquiry 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.
inquiry-idstringYesThe inquiry-id value

persona_identity_retrieve_an_inquiry_session

Retrieve an Inquiry Session 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.
inquiry-session-idstringYesInquiry Session ID

persona_identity_retrieve_an_inquiry_template

Retrieve an Inquiry Template 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.
inquiry-template-idstringYesInquiry Template ID

persona_identity_run_account_action

Run an account action Parameters:
ParameterTypeRequiredDefaultDescription
account-idstringYesThe ID of the account to run the action on
dataobjectYesThe data value

persona_identity_search_accounts

Search Accounts 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_identity_update_an_account

Update an Account 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.
account-idstringYesThe account-id value
dataobjectNoThe data value

persona_identity_update_an_inquiry

Update an Inquiry 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.
inquiry-idstringYesThe inquiry-id value
dataobjectNoThe data value