Persona
personaPersona offers identity infrastructure that allows you to craft personalized and automated verification solutions so you can better understand & protect users.
Acciones disponibles (69)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Tag to AccountPERSONA_ADD_TAG_TO_ACCOUNTAcciónTool to add a tag to an Account in Persona. Use when you need to categorize or label an account with a specific tag. Either tag_id or tag_name must be provided in the request meta.
PERSONA_ADD_TAG_TO_ACCOUNTAcciónTool to add a tag to an Account in Persona. Use when you need to categorize or label an account with a specific tag. Either tag_id or tag_name must be provided in the request meta.
Parámetros de entrada
metaobjectObligatorioMeta object containing tag information (tag_id or tag_name).
fieldsobjectComma-separated list(s) of attributes to include per resource type. See Persona API serialization docs.
includestringA comma-separated list of relationship paths to include in the response (e.g., 'account-type').
account-idstringObligatorioThe ID of the account to add the tag to.
Key-InflectionstringDetermines casing for the API response. Options: camel, kebab, snake.
Idempotency-KeystringEnsures the request is idempotent. Provide a unique key to prevent duplicate tag additions.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Browser Fingerprint List ItemPERSONA_ARCHIVE_A_BROWSER_FINGERPRINT_LIST_ITEMAcciónTool to archive a browser fingerprint list item in Persona. Use when you need to mark a browser fingerprint list item as archived without permanently deleting it.
PERSONA_ARCHIVE_A_BROWSER_FINGERPRINT_LIST_ITEMAcciónTool to archive a browser fingerprint list item in Persona. Use when you need to mark a browser fingerprint list item as archived without permanently deleting it.
Parámetros de entrada
includestringComma-separated list of relationship paths to include in the response.
list_item_idstringObligatorioID of the browser fingerprint list item to archive. Must start with 'libf_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Country List ItemPERSONA_ARCHIVE_A_COUNTRY_LIST_ITEMAcciónTool to archive a Country List Item by ID. Use when you need to mark a country list item as archived. This action is idempotent - archiving an already archived item is safe.
PERSONA_ARCHIVE_A_COUNTRY_LIST_ITEMAcciónTool to archive a Country List Item by ID. Use when you need to mark a country list item as archived. This action is idempotent - archiving an already archived item is safe.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. Use to customize which attributes are serialized.
includestringA comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
list_item_idstringObligatorioID of list item to archive. Starts with 'lic_'.
key_inflectionstringenumKey inflection options for API response casing.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate processing.
persona_versionstringenumPersona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive a Geolocation List ItemPERSONA_ARCHIVE_A_GEOLOCATION_LIST_ITEMAcciónTool to archive a geolocation list item from Persona. Use when you need to archive a specific geolocation list item by its ID. This operation marks the item as archived without permanently deleting it.
PERSONA_ARCHIVE_A_GEOLOCATION_LIST_ITEMAcciónTool to archive a geolocation list item from Persona. Use when you need to archive a specific geolocation list item by its ID. This operation marks the item as archived without permanently deleting it.
Parámetros de entrada
includestringA 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.
list_item_idstringObligatorioID of list item to archive. Must start with 'ligl_' prefix.
Key_InflectionstringenumCasing format for API response.
camelkebabsnakeIdempotency_KeystringEnsures the request is idempotent. Optional header to prevent duplicate operations.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Government ID Number List ItemPERSONA_ARCHIVE_A_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to archive a Government ID Number List Item. Use when you need to remove a government ID number from the active list.
PERSONA_ARCHIVE_A_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to archive a Government ID Number List Item. Use when you need to remove a government ID number from the active list.
Parámetros de entrada
includestringA 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.
list_item_idstringObligatorioID of list item to archive. Starts with 'ligin_'.
key_inflectionstringDetermines casing for the API response. Options: camel, kebab, snake.
idempotency_keystringEnsures the request is idempotent.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive a Name List ItemPERSONA_ARCHIVE_A_NAME_LIST_ITEMAcciónTool to archive a name list item in Persona. Use when you need to archive a specific name list item by its ID.
PERSONA_ARCHIVE_A_NAME_LIST_ITEMAcciónTool to archive a name list item in Persona. Use when you need to archive a specific name list item by its ID.
Parámetros de entrada
list_item_idstringObligatorioID of the name list item to archive. Starts with 'lin_'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive a webhookPERSONA_ARCHIVE_A_WEBHOOKAcciónTool to archive a Persona webhook by its ID. Use when you need to deactivate a webhook without deleting it. Archived webhooks will no longer receive events but can be referenced for historical purposes.
PERSONA_ARCHIVE_A_WEBHOOKAcciónTool to archive a Persona webhook by its ID. Use when you need to deactivate a webhook without deleting it. Archived webhooks will no longer receive events but can be referenced for historical purposes.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
includestringA comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
webhook_idstringObligatorioWebhook's ID (starts with 'wbh_'). This is the unique identifier for the webhook to archive.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Use the same key for retries to avoid duplicate operations.
persona_versionstringenumAPI version to use for the request.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Email Address List ItemPERSONA_ARCHIVE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to archive an Email Address List Item in Persona. Use when you need to archive an email address or domain from a list. The archived item will be marked with an archived timestamp in the response.
PERSONA_ARCHIVE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to archive an Email Address List Item in Persona. Use when you need to archive an email address or domain from a list. The archived item will be marked with an archived timestamp in the response.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. See Persona's Serialization documentation for sparse fieldsets.
includestringA comma-separated list of relationship paths to include in the response. See Persona's Serialization documentation for details.
list_item_idstringObligatorioID of list item to archive. Starts with 'liea_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive IP Address List ItemPERSONA_ARCHIVE_IP_ADDRESS_LIST_ITEMAcciónTool to archive an IP address list item in Persona. Use when you need to remove an IP address from active monitoring.
PERSONA_ARCHIVE_IP_ADDRESS_LIST_ITEMAcciónTool to archive an IP address list item in Persona. Use when you need to remove an IP address from active monitoring.
Parámetros de entrada
includestringA 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.
list_item_idstringObligatorioID of list item to archive. Starts with `liip_`.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Phone Number List ItemPERSONA_ARCHIVE_PHONE_NUMBER_LIST_ITEMAcciónTool to archive a phone number list item in Persona. Use when you need to mark a phone number list item as archived without permanently deleting it.
PERSONA_ARCHIVE_PHONE_NUMBER_LIST_ITEMAcciónTool to archive a phone number list item in Persona. Use when you need to mark a phone number list item as archived without permanently deleting it.
Parámetros de entrada
includestringComma-separated list of relationship paths to include in the response.
list_item_idstringObligatorioID of the phone number list item to archive. Must start with 'lipn_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive String List ItemPERSONA_ARCHIVE_STRING_LIST_ITEMAcciónTool to archive a String List Item in Persona. Use when you need to mark a string list item as archived without permanently deleting it. The item will be marked with an archived timestamp and its status will be updated accordingly.
PERSONA_ARCHIVE_STRING_LIST_ITEMAcciónTool to archive a String List Item in Persona. Use when you need to mark a string list item as archived without permanently deleting it. The item will be marked with an archived timestamp and its status will be updated accordingly.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Persona Serialization documentation for more details.
includestringA 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 Persona Serialization documentation for more details.
list_item_idstringObligatorioID of list item to archive. Example: 'listr_qCSMQ2eh4ftToxJRunQtxHmksrC8'
key_inflectionstringenumCasing format for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clone WebhookPERSONA_CLONE_WEBHOOKAcciónTool to clone an existing Persona webhook. Use when you need to duplicate a webhook configuration with all its settings.
PERSONA_CLONE_WEBHOOKAcciónTool to clone an existing Persona webhook. Use when you need to duplicate a webhook configuration with all its settings.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
includestringA comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
webhook_idstringObligatorioThe ID of the webhook to clone. Must start with "wbh_".
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Use to safely retry requests.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Consolidate AccountsPERSONA_CONSOLIDATE_INTO_ACCOUNTAcciónTool to consolidate multiple source accounts into a single destination account. Use when merging duplicate accounts or combining account data from multiple sources into one primary account.
PERSONA_CONSOLIDATE_INTO_ACCOUNTAcciónTool to consolidate multiple source accounts into a single destination account. Use when merging duplicate accounts or combining account data from multiple sources into one primary account.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
includestringA comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
account_idstringObligatorioDestination Account ID to consolidate source accounts into.
key_inflectionstringDetermines casing for the API response. Valid values: 'camel', 'kebab', 'snake'.
idempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate consolidations.
source_account_idsstring[]ObligatorioA list of source Account IDs that will be consolidated into the destination account. All data from these accounts will be merged into the destination account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create an AccountPERSONA_CREATE_AN_ACCOUNTAcciónTool to create an account in Persona. Use when you need to create a new account with personal information such as name, email, phone, address, and custom fields.
PERSONA_CREATE_AN_ACCOUNTAcciónTool to create an account in Persona. Use when you need to create a new account with personal information such as name, email, phone, address, and custom fields.
Parámetros de entrada
dataobjectObligatorioThe account data to create.
metaobjectMeta information for account creation.
includestringA comma-separated list of relationship paths to include in the response.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create IP Address List ItemPERSONA_CREATE_AN_IP_ADDRESS_LIST_ITEMAcciónTool to create an IP Address List Item in Persona. Use when you need to add an IP address to a watchlist or allowlist for identity verification purposes. The list ID must be obtained first using a list retrieval action.
PERSONA_CREATE_AN_IP_ADDRESS_LIST_ITEMAcciónTool to create an IP Address List Item in Persona. Use when you need to add an IP address to a watchlist or allowlist for identity verification purposes. The list ID must be obtained first using a list retrieval action.
Parámetros de entrada
valuestringObligatorioThe IP address value to add to the list. Can be a single IP address (e.g., '192.168.1.100') or CIDR notation (e.g., '192.168.1.0/24').
includestringA comma-separated list of relationship paths to include in the response (e.g., 'creator').
list_idstringObligatorioThe ID of the list to add the IP address to. Must start with 'lst_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple identical items.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Country List ItemPERSONA_CREATE_COUNTRY_LIST_ITEMAcciónTool to create a country list item in Persona. Use when you need to add a country to a country list for identity verification or compliance purposes.
PERSONA_CREATE_COUNTRY_LIST_ITEMAcciónTool to create a country list item in Persona. Use when you need to add a country to a country list for identity verification or compliance purposes.
Parámetros de entrada
dataobjectObligatorioData object containing the country list item attributes.
fieldsstringComma-separated list of attributes to include in the response (sparse fieldsets).
includestringComma-separated list of relationship paths to include in the response.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Provide a unique key to prevent duplicate creations.
Persona-VersionstringenumServer API version for Persona.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Generic DocumentPERSONA_CREATE_DOCUMENT_GENERICAcciónTool to create a generic document in Persona. Use when you need to create a document record of a specific kind/type for an account or inquiry.
PERSONA_CREATE_DOCUMENT_GENERICAcciónTool to create a generic document in Persona. Use when you need to create a document record of a specific kind/type for an account or inquiry.
Parámetros de entrada
dataobjectObligatorioDocument data containing attributes for the generic document.
includestringComma-separated list of relationship paths to fully serialize in the 'included' key. See https://docs.withpersona.com/serialization#inclusion-of-related-resources
Key-InflectionstringenumCasing format for API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use the same key for retries.
Persona-VersionstringenumAPI version for Persona.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Email Address List ItemPERSONA_CREATE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to create an email address list item in Persona. Use when you need to add an email address to a watchlist or blocklist.
PERSONA_CREATE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to create an email address list item in Persona. Use when you need to add an email address to a watchlist or blocklist.
Parámetros de entrada
valuestringObligatorioThe email address value to add to the list.
includestringA comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_idstringObligatorioThe ID of the list to add the email address to. List IDs typically start with 'lst_'.
match_typestringThe type of match for the list item. Should be 'email_address' for email address list items.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use the same key for retries of the same request.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Government ID Number List ItemPERSONA_CREATE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to create a new government ID number list item in Persona. Use when you need to add a government ID number (such as SSN, passport, or driver's license) to a watchlist or monitoring list.
PERSONA_CREATE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to create a new government ID number list item in Persona. Use when you need to add a government ID number (such as SSN, passport, or driver's license) to a watchlist or monitoring list.
Parámetros de entrada
dataobjectObligatorioThe data object containing the attributes for the list item.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Name List ItemPERSONA_CREATE_NAME_LIST_ITEMAcciónTool to create a new name list item in Persona. Use when you need to add a person's name to a specific list for verification or monitoring purposes.
PERSONA_CREATE_NAME_LIST_ITEMAcciónTool to create a new name list item in Persona. Use when you need to add a person's name to a specific list for verification or monitoring purposes.
Parámetros de entrada
dataobjectObligatorioData object containing the attributes for the name list item.
includestringComma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
Key-InflectionstringenumCasing style for API response keys.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Provide a unique key to prevent duplicate list item creation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Phone Number List ItemPERSONA_CREATE_PHONE_NUMBER_LIST_ITEMAcciónTool to create a phone number list item in Persona. Use when you need to add a phone number to a specific list for tracking or verification purposes.
PERSONA_CREATE_PHONE_NUMBER_LIST_ITEMAcciónTool to create a phone number list item in Persona. Use when you need to add a phone number to a specific list for tracking or verification purposes.
Parámetros de entrada
dataobjectObligatorioThe data object containing attributes for the phone number list item.
includestringA comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use the same key to prevent duplicate creation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create String List ItemPERSONA_CREATE_STRING_LIST_ITEMAcciónTool to create a String List Item in Persona. Use when adding a new string value to an existing list for matching or filtering purposes.
PERSONA_CREATE_STRING_LIST_ITEMAcciónTool to create a String List Item in Persona. Use when adding a new string value to an existing list for matching or filtering purposes.
Parámetros de entrada
valuestringObligatorioThe string value to add to the list.
includestringComma-separated list of relationship paths to include in the response. Customizes which related resources are fully serialized in the 'included' key.
list_idstringObligatorioThe ID of the list to add the string item to. Must be a valid list ID starting with 'lst_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Use the same key for retries to avoid creating duplicate items.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookPERSONA_CREATE_WEBHOOKAcciónTool to create a new webhook in Persona. Use when you need to set up real-time notifications for specific events in your Persona account. The webhook will send POST requests to your URL when enabled events occur.
PERSONA_CREATE_WEBHOOKAcciónTool to create a new webhook in Persona. Use when you need to set up real-time notifications for specific events in your Persona account. The webhook will send POST requests to your URL when enabled events occur.
Parámetros de entrada
urlstringObligatorioTarget URL where webhook events will be sent. Must be a valid HTTPS endpoint.
namestringObligatorioName of the webhook for identification purposes.
fieldsstringComma-separated list of attributes to include in the response for customization.
includestringA comma-separated list of relationship paths to include in the response.
api_versionstringAPI version to use for this webhook. If not specified, uses the account's default version.
descriptionstringHuman-readable description of the webhook's purpose.
enabled_eventsstring[]ObligatorioList of event types that will trigger this webhook. Common events include 'account.created', 'inquiry.completed', 'verification.passed', etc.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakepayload_filterobjectFilter configuration to limit which events trigger the webhook based on payload attributes.
idempotency_keystringEnsures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple webhooks.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18api_key_inflectionstringCasing format for API keys in webhook payload (camel, kebab, or snake).
custom_http_headersobjectCustom HTTP headers to include in webhook requests for authentication or routing.
api_attributes_blockliststring[]List of attributes to exclude from the webhook payload for security or data minimization.
file_access_token_expires_inintegerDuration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Disable WebhookPERSONA_DISABLE_WEBHOOKAcciónTool to disable a webhook in Persona. Use when you need to stop a webhook from receiving events without deleting it.
PERSONA_DISABLE_WEBHOOKAcciónTool to disable a webhook in Persona. Use when you need to stop a webhook from receiving events without deleting it.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
webhook_idstringObligatorioWebhook's ID (starts with 'wbh_')
key_inflectionstringenumCasing options for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent
persona_versionstringenumPersona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable WebhookPERSONA_ENABLE_WEBHOOKAcciónTool to enable a webhook in Persona. Use when you need to activate a previously disabled webhook.
PERSONA_ENABLE_WEBHOOKAcciónTool to enable a webhook in Persona. Use when you need to activate a previously disabled webhook.
Parámetros de entrada
includestringA comma-separated list of relationship paths to include in the response
webhook_idstringObligatorioWebhook's ID (starts with 'wbh_')
key_inflectionstringenumKey inflection options for API response casing.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent
persona_versionstringenumPersona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Expire Inquiry SessionsPERSONA_EXPIRE_INQUIRY_SESSIONSAcciónTool to expire all inquiry sessions for specified inquiry IDs. Use when you need to expire multiple inquiry sessions at once by providing a list of inquiry IDs.
PERSONA_EXPIRE_INQUIRY_SESSIONSAcciónTool to expire all inquiry sessions for specified inquiry IDs. Use when you need to expire multiple inquiry sessions at once by providing a list of inquiry IDs.
Parámetros de entrada
metaobjectObligatorioMeta information containing the list of inquiry IDs to expire.
includestringA comma-separated list of relationship paths to include in the response.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import Email Address ListsPERSONA_IMPORT_EMAIL_ADDRESS_LISTSAcciónTool to import email addresses into a list from a CSV file. Use when you need to bulk import email addresses for identity verification or list management.
PERSONA_IMPORT_EMAIL_ADDRESS_LISTSAcciónTool to import email addresses into a list from a CSV file. Use when you need to bulk import email addresses for identity verification or list management.
Parámetros de entrada
fileobjectObligatorioFile object containing base64 encoded email addresses and filename. The CSV should have columns 'email_address' and 'match_type'.
includestringA 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.
list_idstringObligatorioThe ID of the list to import email addresses into. Must be a valid list ID starting with 'lst_'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import IP Address ListsPERSONA_IMPORT_IP_ADDRESS_LISTSAcciónTool to import IP address lists into Persona. Use when you need to bulk upload IPv4 or IPv6 addresses to an existing list.
PERSONA_IMPORT_IP_ADDRESS_LISTSAcciónTool to import IP address lists into Persona. Use when you need to bulk upload IPv4 or IPv6 addresses to an existing list.
Parámetros de entrada
dataobjectObligatorioData object containing import attributes
includestringA comma-separated list of relationship paths to include in the response
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use a unique key to prevent duplicate imports.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import Name ListsPERSONA_IMPORT_NAME_LISTSAcciónTool to import name lists to Persona. Use when you need to bulk import first and last names to an existing name list for identity verification purposes.
PERSONA_IMPORT_NAME_LISTSAcciónTool to import name lists to Persona. Use when you need to bulk import first and last names to an existing name list for identity verification purposes.
Parámetros de entrada
dataobjectObligatorioData object containing import attributes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import Phone Number ListsPERSONA_IMPORT_PHONE_NUMBER_LISTSAcciónTool to import phone number lists into Persona. Use when you need to bulk upload phone numbers in E.164 format to an existing list.
PERSONA_IMPORT_PHONE_NUMBER_LISTSAcciónTool to import phone number lists into Persona. Use when you need to bulk upload phone numbers in E.164 format to an existing list.
Parámetros de entrada
dataobjectObligatorioData object containing import attributes
includestringA comma-separated list of relationship paths to include in the response
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use a unique key to prevent duplicate imports.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All AccountsPERSONA_LIST_ALL_ACCOUNTSAcciónTool to list all accounts in Persona. Use when you need to retrieve a paginated list of accounts with optional filtering by reference ID or account type.
PERSONA_LIST_ALL_ACCOUNTSAcciónTool to list all accounts in Persona. Use when you need to retrieve a paginated list of accounts with optional filtering by reference ID or account type.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination - retrieves records after this cursor.
page.beforestringCursor for pagination - retrieves records before this cursor.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.reference-idstringFilter accounts by external reference ID.
filter.account-type-idstringFilter accounts by account type ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All API LogsPERSONA_LIST_ALL_API_LOGSAcciónTool to list all API logs in Persona. Use when you need to retrieve a paginated history of API requests made to your organization, including request details, response status, and timing information.
PERSONA_LIST_ALL_API_LOGSAcciónTool to list all API logs in Persona. Use when you need to retrieve a paginated history of API requests made to your organization, including request details, response status, and timing information.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination - retrieves records after this cursor.
page.beforestringCursor for pagination - retrieves records before this cursor.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All CasesPERSONA_LIST_ALL_CASESAcciónTool to list all cases in Persona. Use when you need to retrieve a collection of cases with optional filtering and pagination.
PERSONA_LIST_ALL_CASESAcciónTool to list all cases in Persona. Use when you need to retrieve a collection of cases with optional filtering and pagination.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination. Fetch records after this cursor.
fields.casestringComma-separated list of attributes to include for case resources.
page.beforestringCursor for pagination. Fetch records before this cursor.
filter.statusstringFilter cases by status (e.g., 'open', 'closed').
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.created-at-endstringFilter cases created on or before this timestamp (ISO 8601 format).
filter.created-at-startstringFilter cases created on or after this timestamp (ISO 8601 format).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All DevicesPERSONA_LIST_ALL_DEVICESAcciónTool to list all devices filtered by inquiry session ID. Use when you need to retrieve devices associated with a specific inquiry session.
PERSONA_LIST_ALL_DEVICESAcciónTool to list all devices filtered by inquiry session ID. Use when you need to retrieve devices associated with a specific inquiry session.
Parámetros de entrada
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.inquiry-session-idstringObligatorioFilter devices by inquiry session ID (format: iqse_*).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all EventsPERSONA_LIST_ALL_EVENTSAcciónTool to list all events from Persona. Use when you need to retrieve events for your organization. Supports pagination and filtering by creation date. Events up to 3 months old can be viewed.
PERSONA_LIST_ALL_EVENTSAcciónTool to list all events from Persona. Use when you need to retrieve events for your organization. Supports pagination and filtering by creation date. Events up to 3 months old can be viewed.
Parámetros de entrada
page_sizeintegerNumber of events to return per page. Must be between 1 and 100.
page_afterstringCursor for forward pagination. The object ID that defines your place in the list. Use this to fetch the next page of results.
page_beforestringCursor for backward pagination. The object ID that defines your place in the list. Use this to fetch the previous page of results.
fields_eventsstringComma-separated list of event attributes to include in the response. This can be used to customize which attributes will be serialized. See Persona Serialization docs for more details.
Key_InflectionstringenumCasing format for API response.
camelkebabsnakeIdempotency_KeystringEnsures the request is idempotent. Optional header to prevent duplicate operations.
Persona_VersionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter_created_afterstringFilter events created after this timestamp. Use ISO 8601 format.
filter_created_beforestringFilter events created before this timestamp. Use ISO 8601 format.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all ImportersPERSONA_LIST_ALL_IMPORTERSAcciónTool to list all importers in Persona. Use when you need to retrieve a list of all import operations, including account importers, email address list importers, and other types.
PERSONA_LIST_ALL_IMPORTERSAcciónTool to list all importers in Persona. Use when you need to retrieve a list of all import operations, including account importers, email address list importers, and other types.
Parámetros de entrada
page_sizeintegerNumber of items to return per page. Default is determined by the API.
page_afterstringCursor for pagination. Use the value from 'links.next' in the previous response to fetch the next page.
page_beforestringCursor for pagination. Use the value from 'links.prev' in the previous response to fetch the previous page.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All InquiriesPERSONA_LIST_ALL_INQUIRIESAcciónTool to list all inquiries in Persona. Use when you need to retrieve a paginated collection of inquiries with optional filtering by reference ID, account ID, status, or inquiry template ID.
PERSONA_LIST_ALL_INQUIRIESAcciónTool to list all inquiries in Persona. Use when you need to retrieve a paginated collection of inquiries with optional filtering by reference ID, account ID, status, or inquiry template ID.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination - retrieves records after this cursor.
page.beforestringCursor for pagination - retrieves records before this cursor.
filter.statusstringFilter inquiries by status (e.g., 'pending', 'completed', 'expired').
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakefields.inquirystringComma-separated list of attributes to include for inquiry resources.
Idempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.account-idstringFilter inquiries by account ID.
filter.reference-idstringFilter inquiries by external reference ID.
filter.inquiry-template-idstringFilter inquiries by inquiry template ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Inquiry SessionsPERSONA_LIST_ALL_INQUIRY_SESSIONSAcciónTool to list all inquiry sessions in Persona. Use when you need to retrieve a collection of inquiry sessions with optional filtering.
PERSONA_LIST_ALL_INQUIRY_SESSIONSAcciónTool to list all inquiry sessions in Persona. Use when you need to retrieve a collection of inquiry sessions with optional filtering.
Parámetros de entrada
filterobjectOptional filter parameters to narrow down inquiry session results. Keys can include inquiry session attributes like 'inquiry-id', 'reference-id', 'status', etc.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All ListsPERSONA_LIST_ALL_LISTSAcciónTool to list all lists in Persona. Use when you need to retrieve a paginated collection of lists with optional filtering and field selection.
PERSONA_LIST_ALL_LISTSAcciónTool to list all lists in Persona. Use when you need to retrieve a paginated collection of lists with optional filtering and field selection.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination - retrieves records after this cursor.
page.beforestringCursor for pagination - retrieves records before this cursor.
filter_paramsobjectFilter parameters for the list query. Key-value pairs for filtering results.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized in the response.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Rate LimitsPERSONA_LIST_ALL_RATE_LIMITSAcciónTool to list all rate limits in Persona. Use when you need to retrieve current rate limit information for your API usage.
PERSONA_LIST_ALL_RATE_LIMITSAcciónTool to list all rate limits in Persona. Use when you need to retrieve current rate limit information for your API usage.
Parámetros de entrada
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All ReportsPERSONA_LIST_ALL_REPORTSAcciónTool to list all reports in Persona. Use when you need to retrieve a collection of reports with optional filtering and pagination. Reports can include various types such as adverse media, watchlist, profile, and verification reports.
PERSONA_LIST_ALL_REPORTSAcciónTool to list all reports in Persona. Use when you need to retrieve a collection of reports with optional filtering and pagination. Reports can include various types such as adverse media, watchlist, profile, and verification reports.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination. Fetch records after this cursor.
page.beforestringCursor for pagination. Fetch records before this cursor.
fields.reportstringComma-separated list of attributes to include for report resources.
filter.statusstringFilter reports by status.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.report-template-idstringFilter reports by report template ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All TransactionsPERSONA_LIST_ALL_TRANSACTIONSAcciónTool to list all transactions in Persona. Use when you need to retrieve a paginated collection of transactions with optional filtering.
PERSONA_LIST_ALL_TRANSACTIONSAcciónTool to list all transactions in Persona. Use when you need to retrieve a paginated collection of transactions with optional filtering.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination. Fetch records after this cursor.
page.beforestringCursor for pagination. Fetch records before this cursor.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18fields.transactionstringComma-separated list of attributes to include for transaction resources.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All WebhooksPERSONA_LIST_ALL_WEBHOOKSAcciónTool to list all webhooks in Persona. Use when you need to retrieve a paginated list of webhooks configured for the account.
PERSONA_LIST_ALL_WEBHOOKSAcciónTool to list all webhooks in Persona. Use when you need to retrieve a paginated list of webhooks configured for the account.
Parámetros de entrada
page.sizeintegerNumber of records to return per page.
page.afterstringCursor for pagination - retrieves records after this cursor.
page.beforestringCursor for pagination - retrieves records before this cursor.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakefields.webhookstringComma-separated list of attributes to include for webhook resources.
Idempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all Workflow RunsPERSONA_LIST_ALL_WORKFLOW_RUNSAcciónTool to list all workflow runs in Persona. Use when you need to retrieve workflow runs with optional filtering by workflow ID, inquiry ID, account ID, or session token. Supports pagination for large result sets.
PERSONA_LIST_ALL_WORKFLOW_RUNSAcciónTool to list all workflow runs in Persona. Use when you need to retrieve workflow runs with optional filtering by workflow ID, inquiry ID, account ID, or session token. Supports pagination for large result sets.
Parámetros de entrada
page.sizeintegerNumber of items to return per page. Defaults to API default if not specified.
page.afterstringCursor for pagination to fetch records after this cursor.
page.beforestringCursor for pagination to fetch records before this cursor.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18filter.account-idstringFilter workflow runs by account ID.
filter.inquiry-idstringFilter workflow runs by inquiry ID.
filter.workflow-idstringFilter workflow runs by workflow ID.
fields.workflow-runstringComma-separated list of workflow-run attributes to include in the response.
filter.session-tokenstringFilter workflow runs by session token.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Redact an AccountPERSONA_REDACT_AN_ACCOUNTAcciónTool to permanently redact an account in Persona. Use when you need to delete sensitive personal information from an account to comply with privacy regulations or user requests. This operation is irreversible.
PERSONA_REDACT_AN_ACCOUNTAcciónTool to permanently redact an account in Persona. Use when you need to delete sensitive personal information from an account to comply with privacy regulations or user requests. This operation is irreversible.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
includestringA comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
account_idstringObligatorioThe ID of the account to redact. Must be a valid account ID starting with 'act_'.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Use the same key for retries to avoid duplicate operations.
persona_versionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Account TagPERSONA_REMOVE_ACCOUNT_TAGAcciónTool to remove a tag from a Persona Account. Use when you need to remove a tag association from an account by providing either the tag ID or tag name.
PERSONA_REMOVE_ACCOUNT_TAGAcciónTool to remove a tag from a Persona Account. Use when you need to remove a tag association from an account by providing either the tag ID or tag name.
Parámetros de entrada
metaobjectObligatorioMeta information containing either the tag ID or tag name to remove.
fieldsobjectComma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
account-idstringObligatorioThe ID of the account from which to remove the tag.
Key-InflectionstringDetermines casing for the API response. Options: camel, kebab, snake.
Idempotency-KeystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a Country List ItemPERSONA_RETRIEVE_A_COUNTRY_LIST_ITEMAcciónTool to retrieve a country list item by ID in Persona. Use when you need to fetch details of a specific country list item.
PERSONA_RETRIEVE_A_COUNTRY_LIST_ITEMAcciónTool to retrieve a country list item by ID in Persona. Use when you need to fetch details of a specific country list item.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
includestringA comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorioID of the country list item to retrieve. Starts with 'lic_'.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a Geolocation List ItemPERSONA_RETRIEVE_A_GEOLOCATION_LIST_ITEMAcciónTool to retrieve a geolocation list item from Persona. Use when you need to fetch details of a specific geolocation list item by its ID.
PERSONA_RETRIEVE_A_GEOLOCATION_LIST_ITEMAcciónTool to retrieve a geolocation list item from Persona. Use when you need to fetch details of a specific geolocation list item by its ID.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
list_item_idstringObligatorioID of list item to retrieve. Must start with 'ligl_' prefix.
Key_InflectionstringenumCasing format for API response.
camelkebabsnakeIdempotency_KeystringEnsures the request is idempotent. Optional header to prevent duplicate operations.
Persona_VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an AccountPERSONA_RETRIEVE_AN_ACCOUNTAcciónTool to retrieve an account in Persona. Use when you need to fetch details of a specific account by its ID.
PERSONA_RETRIEVE_AN_ACCOUNTAcciónTool to retrieve an account in Persona. Use when you need to fetch details of a specific account by its ID.
Parámetros de entrada
includestringA comma-separated list of relationship paths to include in the response. This customizes which related resources will be fully serialized in the included key.
account-idstringObligatorioUnique identifier for the account to retrieve.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This customizes which attributes will be serialized.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a Name List ItemPERSONA_RETRIEVE_A_NAME_LIST_ITEMAcciónTool to retrieve a Name List Item in Persona. Use when you need to get details about a specific name list item, including first name, last name, status, match count, and timestamps.
PERSONA_RETRIEVE_A_NAME_LIST_ITEMAcciónTool to retrieve a Name List Item in Persona. Use when you need to get details about a specific name list item, including first name, last name, status, match count, and timestamps.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Persona Serialization documentation for more details.
includestringA 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 Persona Serialization documentation for more details.
list_item_idstringObligatorioID of the name list item to retrieve. Must start with 'lin_'.
key_inflectionstringenumCasing format for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an EventPERSONA_RETRIEVE_AN_EVENTAcciónTool to retrieve an event in Persona. Use when you need to fetch details of a specific event that was logged by Persona.
PERSONA_RETRIEVE_AN_EVENTAcciónTool to retrieve an event in Persona. Use when you need to fetch details of a specific event that was logged by Persona.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
event-idstringObligatorioThe unique identifier of the event to retrieve.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an ImporterPERSONA_RETRIEVE_AN_IMPORTERAcciónTool to retrieve a specific importer in Persona. Use when you need to get details about a specific import operation by its ID.
PERSONA_RETRIEVE_AN_IMPORTERAcciónTool to retrieve a specific importer in Persona. Use when you need to get details about a specific import operation by its ID.
Parámetros de entrada
includestringA 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.
importer_idstringObligatorioString ID of the importer to retrieve.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve IP Address List ItemPERSONA_RETRIEVE_AN_IP_ADDRESS_LIST_ITEMAcciónTool to retrieve an IP Address List Item in Persona. Use when you need to get details about a specific IP address list item, including its value, status, match count, and timestamps.
PERSONA_RETRIEVE_AN_IP_ADDRESS_LIST_ITEMAcciónTool to retrieve an IP Address List Item in Persona. Use when you need to get details about a specific IP address list item, including its value, status, match count, and timestamps.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Persona Serialization documentation for more details.
includestringA 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 Persona Serialization documentation for more details.
list_item_idstringObligatorioID of the IP address list item to retrieve. Must start with 'liip_'.
key_inflectionstringenumCasing format for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an API LogPERSONA_RETRIEVE_API_LOGAcciónTool to retrieve an API log in Persona. Use when you need to fetch details of a specific API request/response that was logged by Persona.
PERSONA_RETRIEVE_API_LOGAcciónTool to retrieve an API log in Persona. Use when you need to fetch details of a specific API request/response that was logged by Persona.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
api-log-idstringObligatorioThe unique identifier of the API log to retrieve.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a String List ItemPERSONA_RETRIEVE_A_STRING_LIST_ITEMAcciónTool to retrieve a string list item by ID in Persona. Use when you need to fetch details of a specific string list item.
PERSONA_RETRIEVE_A_STRING_LIST_ITEMAcciónTool to retrieve a string list item by ID in Persona. Use when you need to fetch details of a specific string list item.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
includestringA comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorioID of the string list item to retrieve. Starts with 'listr_'.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a WebhookPERSONA_RETRIEVE_A_WEBHOOKAcciónTool to retrieve a webhook by its ID. Use when you need to fetch details about a specific webhook configuration.
PERSONA_RETRIEVE_A_WEBHOOKAcciónTool to retrieve a webhook by its ID. Use when you need to fetch details about a specific webhook configuration.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. Keys are resource types, values are comma-separated attribute names.
includestringA 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.
webhook-idstringObligatorioWebhook's ID (starts with 'wbh_').
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Browser Fingerprint List ItemPERSONA_RETRIEVE_BROWSER_FINGERPRINT_LIST_ITEMAcciónTool to retrieve a browser fingerprint list item in Persona. Use when you need to fetch details of a specific browser fingerprint from a list for identity verification or fraud prevention purposes.
PERSONA_RETRIEVE_BROWSER_FINGERPRINT_LIST_ITEMAcciónTool to retrieve a browser fingerprint list item in Persona. Use when you need to fetch details of a specific browser fingerprint from a list for identity verification or fraud prevention purposes.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
list-item-idstringObligatorioID of the browser fingerprint list item to retrieve. Starts with 'libf_'.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a DocumentPERSONA_RETRIEVE_DOCUMENTAcciónTool to retrieve a document from Persona. Use when you need to fetch details of a specific document by its ID.
PERSONA_RETRIEVE_DOCUMENTAcciónTool to retrieve a document from Persona. Use when you need to fetch details of a specific document by its ID.
Parámetros de entrada
includestringA comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the `included` key in the response.
document-idstringObligatorioThe unique identifier of the document to retrieve.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Generic DocumentPERSONA_RETRIEVE_DOCUMENT_GENERICAcciónTool to retrieve a generic document in Persona. Use when you need to fetch details of a specific document by its ID.
PERSONA_RETRIEVE_DOCUMENT_GENERICAcciónTool to retrieve a generic document in Persona. Use when you need to fetch details of a specific document by its ID.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response. See https://docs.withpersona.com/serialization#sparse-fieldsets
includestringA 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 https://docs.withpersona.com/serialization#inclusion-of-related-resources
document-idstringObligatorioThe unique identifier of the generic document to retrieve.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Email Address List ItemPERSONA_RETRIEVE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to retrieve an Email Address List Item in Persona. Use when you need to get details about a specific email address list item, including its value, status, match count, and timestamps.
PERSONA_RETRIEVE_EMAIL_ADDRESS_LIST_ITEMAcciónTool to retrieve an Email Address List Item in Persona. Use when you need to get details about a specific email address list item, including its value, status, match count, and timestamps.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Persona Serialization documentation for more details.
includestringA 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 Persona Serialization documentation for more details.
list_item_idstringObligatorioID of the email address list item to retrieve. Must start with 'liea_'.
key_inflectionstringenumCasing format for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Government ID Number List ItemPERSONA_RETRIEVE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to retrieve a Government ID Number List Item in Persona. Use when you need to get details about a specific government ID number list item, including its ID number, ID class, status, match count, and timestamps.
PERSONA_RETRIEVE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcciónTool to retrieve a Government ID Number List Item in Persona. Use when you need to get details about a specific government ID number list item, including its ID number, ID class, status, match count, and timestamps.
Parámetros de entrada
fieldsstringComma-separated list of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Persona Serialization documentation for more details.
includestringA 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 Persona Serialization documentation for more details.
list_item_idstringObligatorioID of the government ID number list item to retrieve. Must start with 'ligin_'.
key_inflectionstringenumCasing format for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenumPersona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Phone Number List ItemPERSONA_RETRIEVE_PHONE_NUMBER_LIST_ITEMAcciónTool to retrieve a phone number list item in Persona. Use when you need to fetch details of a specific phone number from a list for identity verification or fraud prevention purposes.
PERSONA_RETRIEVE_PHONE_NUMBER_LIST_ITEMAcciónTool to retrieve a phone number list item in Persona. Use when you need to fetch details of a specific phone number from a list for identity verification or fraud prevention purposes.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
list-item-idstringObligatorioID of the phone number list item to retrieve. Starts with 'lipn_'.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Rotate Webhook SecretPERSONA_ROTATE_WEBHOOK_SECRETAcciónTool to rotate a webhook's secret in Persona. Use when you need to generate a new secret key for webhook signature verification while optionally keeping the old secret active for a grace period.
PERSONA_ROTATE_WEBHOOK_SECRETAcciónTool to rotate a webhook's secret in Persona. Use when you need to generate a new secret key for webhook signature verification while optionally keeping the old secret active for a grace period.
Parámetros de entrada
fieldsobjectComma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestringA 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.
webhook_idstringObligatorioWebhook's ID (starts with 'wbh_')
key_inflectionstringenumCasing options for API response.
camelkebabsnakeidempotency_keystringEnsures the request is idempotent
persona_versionstringenumPersona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18expires_in_secondsintegerSeconds until currently active webhook secret expires. If not specified, the old secret expires immediately upon rotation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search AccountsPERSONA_SEARCH_ACCOUNTSAcciónTool to search accounts in Persona using flexible query criteria. Use when you need to find accounts based on specific attributes, tags, or status. Supports boolean logic (AND/OR/NOT) and comparison operators.
PERSONA_SEARCH_ACCOUNTSAcciónTool to search accounts in Persona using flexible query criteria. Use when you need to find accounts based on specific attributes, tags, or status. Supports boolean logic (AND/OR/NOT) and comparison operators.
Parámetros de entrada
pageobjectPagination configuration.
sortobjectSort configuration for results.
queryobjectSearch 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). Example: {'and': [{'attribute': 'account-status', 'operator': 'eq', 'value': 'active'}]}
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search CasesPERSONA_SEARCH_CASESAcciónTool to search cases in Persona using advanced query filters with boolean logic. Use when you need to find cases matching specific criteria using operators like eq, gt, gte, lt, lte combined with AND/OR/NOT logic.
PERSONA_SEARCH_CASESAcciónTool to search cases in Persona using advanced query filters with boolean logic. Use when you need to find cases matching specific criteria using operators like eq, gt, gte, lt, lte combined with AND/OR/NOT logic.
Parámetros de entrada
pageobjectPagination parameters for search results.
sortobjectSort configuration for search results.
queryobjectSearch 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). Example: {'and': [{'attribute': 'status', 'operator': 'eq', 'value': 'open'}, {'attribute': 'created-at', 'operator': 'gte', 'value': '2023-01-01T00:00:00Z'}]} or {'or': [{'attribute': 'status', 'operator': 'eq', 'value': 'open'}, {'attribute': 'status', 'operator': 'eq', 'value': 'pending'}]} or {'not': {'attribute': 'status', 'operator': 'eq', 'value': 'closed'}} or simple predicate: {'attribute': 'status', 'operator': 'eq', 'value': 'open'}
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Tags on AccountPERSONA_SET_TAGSAcciónTool to set tags on a Persona Account. Use when you need to assign or update tags for an account using either tag IDs or tag names. This operation replaces all existing tags with the provided ones.
PERSONA_SET_TAGSAcciónTool to set tags on a Persona Account. Use when you need to assign or update tags for an account using either tag IDs or tag names. This operation replaces all existing tags with the provided ones.
Parámetros de entrada
metaobjectObligatorioMeta object containing tag information (tag_id or tag_name arrays).
fieldsobjectComma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestringA comma-separated list of relationship paths to include in the response. This can be used to customize which related resources will be fully serialized in the 'included' key.
account-idstringObligatorioThe ID of the account to set tags on.
Key-InflectionstringenumKey inflection options for API response casing.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Provide a unique key to prevent duplicate operations.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update an AccountPERSONA_UPDATE_AN_ACCOUNTAcciónTool to update an account in Persona. Use when you need to modify account information such as name, email, phone, address, reference ID, or custom fields.
PERSONA_UPDATE_AN_ACCOUNTAcciónTool to update an account in Persona. Use when you need to modify account information such as name, email, phone, address, reference ID, or custom fields.
Parámetros de entrada
dataobjectObligatorioThe account data to update.
includestringA comma-separated list of relationship paths to include in the response.
account-idstringObligatorioUnique identifier for the account to update.
sparse_fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update a WebhookPERSONA_UPDATE_A_WEBHOOKAcciónTool to update a webhook in Persona. Use when you need to modify webhook configuration such as name, description, URL, or enabled events.
PERSONA_UPDATE_A_WEBHOOKAcciónTool to update a webhook in Persona. Use when you need to modify webhook configuration such as name, description, URL, or enabled events.
Parámetros de entrada
urlstringTarget URL where webhook events will be sent. Must be a valid HTTPS endpoint.
namestringName of the webhook for identification purposes.
fieldsobjectComma-separated list(s) of attributes to include in the response. Keys are resource types, values are comma-separated attribute names.
includestringA comma-separated list of relationship paths to include in the response.
webhook_idstringObligatorioWebhook's ID (starts with 'wbh_').
api_versionstringAPI version to use for this webhook. If not specified, uses the account's default version.
descriptionstringHuman-readable description of the webhook's purpose.
enabled_eventsstring[]List of event types that will trigger this webhook. Common events include 'account.created', 'inquiry.completed', 'verification.passed', etc.
key_inflectionstringenumDetermines casing for the API response.
camelkebabsnakepayload_filterobjectFilter configuration to limit which events trigger the webhook based on payload attributes.
idempotency_keystringEnsures the request is idempotent. Use the same key for duplicate requests.
persona_versionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18api_key_inflectionstringCasing format for API keys in webhook payload (camel, kebab, or snake).
custom_http_headersobjectCustom HTTP headers to include in webhook requests for authentication or routing.
api_attributes_blockliststring[]List of attributes to exclude from the webhook payload for security or data minimization.
file_access_token_expires_inintegerDuration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Generic DocumentPERSONA_UPDATE_DOCUMENT_GENERICAcciónTool to update a generic document in Persona. Use when you need to modify fields, files, or kind of an existing document by its ID.
PERSONA_UPDATE_DOCUMENT_GENERICAcciónTool to update a generic document in Persona. Use when you need to modify fields, files, or kind of an existing document by its ID.
Parámetros de entrada
dataobjectObligatorioDocument data containing attributes to update.
fieldsobjectComma-separated list(s) of attributes to include in the response, keyed by resource type. This can be used to customize which attributes will be serialized in the response. See https://docs.withpersona.com/serialization#sparse-fieldsets
includestringA 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 https://docs.withpersona.com/serialization#inclusion-of-related-resources
document-idstringObligatorioThe unique identifier of the generic document to update.
Key-InflectionstringenumDetermines casing for the API response.
camelkebabsnakeIdempotency-KeystringEnsures the request is idempotent. Use the same key for retries. Sent as header.
Persona-VersionstringenumServer API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not