Persona

persona

Persona offers identity infrastructure that allows you to craft personalized and automated verification solutions so you can better understand & protect users.

Security & Identity Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

metaobjectObligatorio
Meta object containing tag information (tag_id or tag_name).
fieldsobject
Comma-separated list(s) of attributes to include per resource type. See Persona API serialization docs.
includestring
A comma-separated list of relationship paths to include in the response (e.g., 'account-type').
account-idstringObligatorio
The ID of the account to add the tag to.
Key-Inflectionstring
Determines casing for the API response. Options: camel, kebab, snake.
Idempotency-Keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate tag additions.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Browser Fingerprint List ItemPERSONA_ARCHIVE_A_BROWSER_FINGERPRINT_LIST_ITEMAcción

Tool 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

includestring
Comma-separated list of relationship paths to include in the response.
list_item_idstringObligatorio
ID of the browser fingerprint list item to archive. Must start with 'libf_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Country List ItemPERSONA_ARCHIVE_A_COUNTRY_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-separated list of attributes to include in the response. Use to customize which attributes are serialized.
includestring
A comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
list_item_idstringObligatorio
ID of list item to archive. Starts with 'lic_'.
key_inflectionstringenum
Key inflection options for API response casing.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate processing.
persona_versionstringenum
Persona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive a Geolocation List ItemPERSONA_ARCHIVE_A_GEOLOCATION_LIST_ITEMAcción

Tool 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

includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorio
ID of list item to archive. Must start with 'ligl_' prefix.
Key_Inflectionstringenum
Casing format for API response.
camelkebabsnake
Idempotency_Keystring
Ensures the request is idempotent. Optional header to prevent duplicate operations.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Government ID Number List ItemPERSONA_ARCHIVE_A_GOVERNMENT_ID_NUMBER_LIST_ITEMAcción

Tool 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

includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response.
list_item_idstringObligatorio
ID of list item to archive. Starts with 'ligin_'.
key_inflectionstring
Determines casing for the API response. Options: camel, kebab, snake.
idempotency_keystring
Ensures the request is idempotent.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive a Name List ItemPERSONA_ARCHIVE_A_NAME_LIST_ITEMAcción

Tool 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_idstringObligatorio
ID of the name list item to archive. Starts with 'lin_'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive a webhookPERSONA_ARCHIVE_A_WEBHOOKAcción

Tool 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

fieldsobject
Comma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
includestring
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
webhook_idstringObligatorio
Webhook's ID (starts with 'wbh_'). This is the unique identifier for the webhook to archive.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Use the same key for retries to avoid duplicate operations.
persona_versionstringenum
API 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Email Address List ItemPERSONA_ARCHIVE_EMAIL_ADDRESS_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-separated list of attributes to include in the response. See Persona's Serialization documentation for sparse fieldsets.
includestring
A comma-separated list of relationship paths to include in the response. See Persona's Serialization documentation for details.
list_item_idstringObligatorio
ID of list item to archive. Starts with 'liea_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive IP Address List ItemPERSONA_ARCHIVE_IP_ADDRESS_LIST_ITEMAcción

Tool 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

includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response.
list_item_idstringObligatorio
ID of list item to archive. Starts with `liip_`.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Phone Number List ItemPERSONA_ARCHIVE_PHONE_NUMBER_LIST_ITEMAcción

Tool 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

includestring
Comma-separated list of relationship paths to include in the response.
list_item_idstringObligatorio
ID of the phone number list item to archive. Must start with 'lipn_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive String List ItemPERSONA_ARCHIVE_STRING_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See Persona Serialization documentation for more details.
list_item_idstringObligatorio
ID of list item to archive. Example: 'listr_qCSMQ2eh4ftToxJRunQtxHmksrC8'
key_inflectionstringenum
Casing format for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Clone WebhookPERSONA_CLONE_WEBHOOKAcción

Tool to clone an existing Persona webhook. Use when you need to duplicate a webhook configuration with all its settings.

Parámetros de entrada

fieldsstring
Comma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
includestring
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
webhook_idstringObligatorio
The ID of the webhook to clone. Must start with "wbh_".
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Use to safely retry requests.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Consolidate AccountsPERSONA_CONSOLIDATE_INTO_ACCOUNTAcción

Tool 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

fieldsstring
Comma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
includestring
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
account_idstringObligatorio
Destination Account ID to consolidate source accounts into.
key_inflectionstring
Determines casing for the API response. Valid values: 'camel', 'kebab', 'snake'.
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate consolidations.
source_account_idsstring[]Obligatorio
A 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an AccountPERSONA_CREATE_AN_ACCOUNTAcción

Tool 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

dataobjectObligatorio
The account data to create.
metaobject
Meta information for account creation.
includestring
A comma-separated list of relationship paths to include in the response.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create IP Address List ItemPERSONA_CREATE_AN_IP_ADDRESS_LIST_ITEMAcción

Tool 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

valuestringObligatorio
The 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').
includestring
A comma-separated list of relationship paths to include in the response (e.g., 'creator').
list_idstringObligatorio
The ID of the list to add the IP address to. Must start with 'lst_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple identical items.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Country List ItemPERSONA_CREATE_COUNTRY_LIST_ITEMAcción

Tool 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

dataobjectObligatorio
Data object containing the country list item attributes.
fieldsstring
Comma-separated list of attributes to include in the response (sparse fieldsets).
includestring
Comma-separated list of relationship paths to include in the response.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate creations.
Persona-Versionstringenum
Server 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Generic DocumentPERSONA_CREATE_DOCUMENT_GENERICAcción

Tool 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

dataobjectObligatorio
Document data containing attributes for the generic document.
includestring
Comma-separated list of relationship paths to fully serialize in the 'included' key. See https://docs.withpersona.com/serialization#inclusion-of-related-resources
Key-Inflectionstringenum
Casing format for API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use the same key for retries.
Persona-Versionstringenum
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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Email Address List ItemPERSONA_CREATE_EMAIL_ADDRESS_LIST_ITEMAcción

Tool 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

valuestringObligatorio
The email address value to add to the list.
includestring
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_idstringObligatorio
The ID of the list to add the email address to. List IDs typically start with 'lst_'.
match_typestring
The type of match for the list item. Should be 'email_address' for email address list items.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use the same key for retries of the same request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Government ID Number List ItemPERSONA_CREATE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcción

Tool 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

dataobjectObligatorio
The data object containing the attributes for the list item.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Name List ItemPERSONA_CREATE_NAME_LIST_ITEMAcción

Tool 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

dataobjectObligatorio
Data object containing the attributes for the name list item.
includestring
Comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
Key-Inflectionstringenum
Casing style for API response keys.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate list item creation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Phone Number List ItemPERSONA_CREATE_PHONE_NUMBER_LIST_ITEMAcción

Tool 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

dataobjectObligatorio
The data object containing attributes for the phone number list item.
includestring
A comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use the same key to prevent duplicate creation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create String List ItemPERSONA_CREATE_STRING_LIST_ITEMAcción

Tool 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

valuestringObligatorio
The string value to add to the list.
includestring
Comma-separated list of relationship paths to include in the response. Customizes which related resources are fully serialized in the 'included' key.
list_idstringObligatorio
The ID of the list to add the string item to. Must be a valid list ID starting with 'lst_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Use the same key for retries to avoid creating duplicate items.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookPERSONA_CREATE_WEBHOOKAcción

Tool 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

urlstringObligatorio
Target URL where webhook events will be sent. Must be a valid HTTPS endpoint.
namestringObligatorio
Name of the webhook for identification purposes.
fieldsstring
Comma-separated list of attributes to include in the response for customization.
includestring
A comma-separated list of relationship paths to include in the response.
api_versionstring
API version to use for this webhook. If not specified, uses the account's default version.
descriptionstring
Human-readable description of the webhook's purpose.
enabled_eventsstring[]Obligatorio
List of event types that will trigger this webhook. Common events include 'account.created', 'inquiry.completed', 'verification.passed', etc.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
payload_filterobject
Filter configuration to limit which events trigger the webhook based on payload attributes.
idempotency_keystring
Ensures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple webhooks.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
api_key_inflectionstring
Casing format for API keys in webhook payload (camel, kebab, or snake).
custom_http_headersobject
Custom 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_ininteger
Duration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable WebhookPERSONA_DISABLE_WEBHOOKAcción

Tool to disable a webhook in Persona. Use when you need to stop a webhook from receiving events without deleting it.

Parámetros de entrada

fieldsobject
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response. See Serialization for more details.
webhook_idstringObligatorio
Webhook's ID (starts with 'wbh_')
key_inflectionstringenum
Casing options for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent
persona_versionstringenum
Persona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable WebhookPERSONA_ENABLE_WEBHOOKAcción

Tool to enable a webhook in Persona. Use when you need to activate a previously disabled webhook.

Parámetros de entrada

includestring
A comma-separated list of relationship paths to include in the response
webhook_idstringObligatorio
Webhook's ID (starts with 'wbh_')
key_inflectionstringenum
Key inflection options for API response casing.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent
persona_versionstringenum
Persona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Expire Inquiry SessionsPERSONA_EXPIRE_INQUIRY_SESSIONSAcción

Tool 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

metaobjectObligatorio
Meta information containing the list of inquiry IDs to expire.
includestring
A comma-separated list of relationship paths to include in the response.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import Email Address ListsPERSONA_IMPORT_EMAIL_ADDRESS_LISTSAcción

Tool 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

fileobjectObligatorio
File object containing base64 encoded email addresses and filename. The CSV should have columns 'email_address' and 'match_type'.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response.
list_idstringObligatorio
The ID of the list to import email addresses into. Must be a valid list ID starting with 'lst_'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import IP Address ListsPERSONA_IMPORT_IP_ADDRESS_LISTSAcción

Tool 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

dataobjectObligatorio
Data object containing import attributes
includestring
A comma-separated list of relationship paths to include in the response
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use a unique key to prevent duplicate imports.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import Name ListsPERSONA_IMPORT_NAME_LISTSAcción

Tool 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

dataobjectObligatorio
Data object containing import attributes.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import Phone Number ListsPERSONA_IMPORT_PHONE_NUMBER_LISTSAcción

Tool 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

dataobjectObligatorio
Data object containing import attributes
includestring
A comma-separated list of relationship paths to include in the response
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use a unique key to prevent duplicate imports.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All AccountsPERSONA_LIST_ALL_ACCOUNTSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination - retrieves records after this cursor.
page.beforestring
Cursor for pagination - retrieves records before this cursor.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.reference-idstring
Filter accounts by external reference ID.
filter.account-type-idstring
Filter accounts by account type ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All API LogsPERSONA_LIST_ALL_API_LOGSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination - retrieves records after this cursor.
page.beforestring
Cursor for pagination - retrieves records before this cursor.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All CasesPERSONA_LIST_ALL_CASESAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination. Fetch records after this cursor.
fields.casestring
Comma-separated list of attributes to include for case resources.
page.beforestring
Cursor for pagination. Fetch records before this cursor.
filter.statusstring
Filter cases by status (e.g., 'open', 'closed').
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.created-at-endstring
Filter cases created on or before this timestamp (ISO 8601 format).
filter.created-at-startstring
Filter cases created on or after this timestamp (ISO 8601 format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All DevicesPERSONA_LIST_ALL_DEVICESAcción

Tool 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-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.inquiry-session-idstringObligatorio
Filter devices by inquiry session ID (format: iqse_*).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all EventsPERSONA_LIST_ALL_EVENTSAcción

Tool 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_sizeinteger
Number of events to return per page. Must be between 1 and 100.
page_afterstring
Cursor for forward pagination. The object ID that defines your place in the list. Use this to fetch the next page of results.
page_beforestring
Cursor for backward pagination. The object ID that defines your place in the list. Use this to fetch the previous page of results.
fields_eventsstring
Comma-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_Inflectionstringenum
Casing format for API response.
camelkebabsnake
Idempotency_Keystring
Ensures the request is idempotent. Optional header to prevent duplicate operations.
Persona_Versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter_created_afterstring
Filter events created after this timestamp. Use ISO 8601 format.
filter_created_beforestring
Filter events created before this timestamp. Use ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all ImportersPERSONA_LIST_ALL_IMPORTERSAcción

Tool 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_sizeinteger
Number of items to return per page. Default is determined by the API.
page_afterstring
Cursor for pagination. Use the value from 'links.next' in the previous response to fetch the next page.
page_beforestring
Cursor for pagination. Use the value from 'links.prev' in the previous response to fetch the previous page.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All InquiriesPERSONA_LIST_ALL_INQUIRIESAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination - retrieves records after this cursor.
page.beforestring
Cursor for pagination - retrieves records before this cursor.
filter.statusstring
Filter inquiries by status (e.g., 'pending', 'completed', 'expired').
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
fields.inquirystring
Comma-separated list of attributes to include for inquiry resources.
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.account-idstring
Filter inquiries by account ID.
filter.reference-idstring
Filter inquiries by external reference ID.
filter.inquiry-template-idstring
Filter inquiries by inquiry template ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All Inquiry SessionsPERSONA_LIST_ALL_INQUIRY_SESSIONSAcción

Tool 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

filterobject
Optional filter parameters to narrow down inquiry session results. Keys can include inquiry session attributes like 'inquiry-id', 'reference-id', 'status', etc.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All ListsPERSONA_LIST_ALL_LISTSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination - retrieves records after this cursor.
page.beforestring
Cursor for pagination - retrieves records before this cursor.
filter_paramsobject
Filter parameters for the list query. Key-value pairs for filtering results.
sparse_fieldsobject
Comma-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-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All Rate LimitsPERSONA_LIST_ALL_RATE_LIMITSAcción

Tool 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-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All ReportsPERSONA_LIST_ALL_REPORTSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination. Fetch records after this cursor.
page.beforestring
Cursor for pagination. Fetch records before this cursor.
fields.reportstring
Comma-separated list of attributes to include for report resources.
filter.statusstring
Filter reports by status.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.report-template-idstring
Filter reports by report template ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All TransactionsPERSONA_LIST_ALL_TRANSACTIONSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination. Fetch records after this cursor.
page.beforestring
Cursor for pagination. Fetch records before this cursor.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
fields.transactionstring
Comma-separated list of attributes to include for transaction resources.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All WebhooksPERSONA_LIST_ALL_WEBHOOKSAcción

Tool 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.sizeinteger
Number of records to return per page.
page.afterstring
Cursor for pagination - retrieves records after this cursor.
page.beforestring
Cursor for pagination - retrieves records before this cursor.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
fields.webhookstring
Comma-separated list of attributes to include for webhook resources.
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all Workflow RunsPERSONA_LIST_ALL_WORKFLOW_RUNSAcción

Tool 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.sizeinteger
Number of items to return per page. Defaults to API default if not specified.
page.afterstring
Cursor for pagination to fetch records after this cursor.
page.beforestring
Cursor for pagination to fetch records before this cursor.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
filter.account-idstring
Filter workflow runs by account ID.
filter.inquiry-idstring
Filter workflow runs by inquiry ID.
filter.workflow-idstring
Filter workflow runs by workflow ID.
fields.workflow-runstring
Comma-separated list of workflow-run attributes to include in the response.
filter.session-tokenstring
Filter workflow runs by session token.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Redact an AccountPERSONA_REDACT_AN_ACCOUNTAcción

Tool 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

fieldsobject
Comma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
includestring
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
account_idstringObligatorio
The ID of the account to redact. Must be a valid account ID starting with 'act_'.
key_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Use the same key for retries to avoid duplicate operations.
persona_versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Account TagPERSONA_REMOVE_ACCOUNT_TAGAcción

Tool 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

metaobjectObligatorio
Meta information containing either the tag ID or tag name to remove.
fieldsobject
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response.
account-idstringObligatorio
The ID of the account from which to remove the tag.
Key-Inflectionstring
Determines casing for the API response. Options: camel, kebab, snake.
Idempotency-Keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a Country List ItemPERSONA_RETRIEVE_A_COUNTRY_LIST_ITEMAcción

Tool 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

fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
includestring
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorio
ID of the country list item to retrieve. Starts with 'lic_'.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a Geolocation List ItemPERSONA_RETRIEVE_A_GEOLOCATION_LIST_ITEMAcción

Tool 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

fieldsobject
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorio
ID of list item to retrieve. Must start with 'ligl_' prefix.
Key_Inflectionstringenum
Casing format for API response.
camelkebabsnake
Idempotency_Keystring
Ensures the request is idempotent. Optional header to prevent duplicate operations.
Persona_Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an AccountPERSONA_RETRIEVE_AN_ACCOUNTAcción

Tool to retrieve an account in Persona. Use when you need to fetch details of a specific account by its ID.

Parámetros de entrada

includestring
A 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-idstringObligatorio
Unique identifier for the account to retrieve.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. This customizes which attributes will be serialized.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a Name List ItemPERSONA_RETRIEVE_A_NAME_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response. See Persona Serialization documentation for more details.
list_item_idstringObligatorio
ID of the name list item to retrieve. Must start with 'lin_'.
key_inflectionstringenum
Casing format for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an EventPERSONA_RETRIEVE_AN_EVENTAcción

Tool 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

fieldsobject
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response.
event-idstringObligatorio
The unique identifier of the event to retrieve.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an ImporterPERSONA_RETRIEVE_AN_IMPORTERAcción

Tool 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

includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response.
importer_idstringObligatorio
String ID of the importer to retrieve.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve IP Address List ItemPERSONA_RETRIEVE_AN_IP_ADDRESS_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See Persona Serialization documentation for more details.
list_item_idstringObligatorio
ID of the IP address list item to retrieve. Must start with 'liip_'.
key_inflectionstringenum
Casing format for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an API LogPERSONA_RETRIEVE_API_LOGAcción

Tool 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

fieldsobject
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response.
api-log-idstringObligatorio
The unique identifier of the API log to retrieve.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a String List ItemPERSONA_RETRIEVE_A_STRING_LIST_ITEMAcción

Tool 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

fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
includestring
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
list_item_idstringObligatorio
ID of the string list item to retrieve. Starts with 'listr_'.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a WebhookPERSONA_RETRIEVE_A_WEBHOOKAcción

Tool to retrieve a webhook by its ID. Use when you need to fetch details about a specific webhook configuration.

Parámetros de entrada

fieldsobject
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. Keys are resource types, values are comma-separated attribute names.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response.
webhook-idstringObligatorio
Webhook's ID (starts with 'wbh_').
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Browser Fingerprint List ItemPERSONA_RETRIEVE_BROWSER_FINGERPRINT_LIST_ITEMAcción

Tool 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

fieldsobject
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response.
list-item-idstringObligatorio
ID of the browser fingerprint list item to retrieve. Starts with 'libf_'.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a DocumentPERSONA_RETRIEVE_DOCUMENTAcción

Tool to retrieve a document from Persona. Use when you need to fetch details of a specific document by its ID.

Parámetros de entrada

includestring
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the `included` key in the response.
document-idstringObligatorio
The unique identifier of the document to retrieve.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Generic DocumentPERSONA_RETRIEVE_DOCUMENT_GENERICAcción

Tool 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

fieldsobject
Comma-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
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See https://docs.withpersona.com/serialization#inclusion-of-related-resources
document-idstringObligatorio
The unique identifier of the generic document to retrieve.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Email Address List ItemPERSONA_RETRIEVE_EMAIL_ADDRESS_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See Persona Serialization documentation for more details.
list_item_idstringObligatorio
ID of the email address list item to retrieve. Must start with 'liea_'.
key_inflectionstringenum
Casing format for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Government ID Number List ItemPERSONA_RETRIEVE_GOVERNMENT_ID_NUMBER_LIST_ITEMAcción

Tool 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

fieldsstring
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See Persona Serialization documentation for more details.
list_item_idstringObligatorio
ID of the government ID number list item to retrieve. Must start with 'ligin_'.
key_inflectionstringenum
Casing format for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
persona_versionstringenum
Persona API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Phone Number List ItemPERSONA_RETRIEVE_PHONE_NUMBER_LIST_ITEMAcción

Tool 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

fieldsobject
Comma-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.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response.
list-item-idstringObligatorio
ID of the phone number list item to retrieve. Starts with 'lipn_'.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rotate Webhook SecretPERSONA_ROTATE_WEBHOOK_SECRETAcción

Tool 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

fieldsobject
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the 'included' key in the response.
webhook_idstringObligatorio
Webhook's ID (starts with 'wbh_')
key_inflectionstringenum
Casing options for API response.
camelkebabsnake
idempotency_keystring
Ensures the request is idempotent
persona_versionstringenum
Persona API version options.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
expires_in_secondsinteger
Seconds until currently active webhook secret expires. If not specified, the old secret expires immediately upon rotation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search AccountsPERSONA_SEARCH_ACCOUNTSAcción

Tool 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

pageobject
Pagination configuration.
sortobject
Sort configuration for results.
queryobject
Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Example: {'and': [{'attribute': 'account-status', 'operator': 'eq', 'value': 'active'}]}
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search CasesPERSONA_SEARCH_CASESAcción

Tool 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

pageobject
Pagination parameters for search results.
sortobject
Sort configuration for search results.
queryobject
Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). 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-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Tags on AccountPERSONA_SET_TAGSAcción

Tool 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

metaobjectObligatorio
Meta object containing tag information (tag_id or tag_name arrays).
fieldsobject
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response.
includestring
A 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-idstringObligatorio
The ID of the account to set tags on.
Key-Inflectionstringenum
Key inflection options for API response casing.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an AccountPERSONA_UPDATE_AN_ACCOUNTAcción

Tool 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

dataobjectObligatorio
The account data to update.
includestring
A comma-separated list of relationship paths to include in the response.
account-idstringObligatorio
Unique identifier for the account to update.
sparse_fieldsobject
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a WebhookPERSONA_UPDATE_A_WEBHOOKAcción

Tool 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

urlstring
Target URL where webhook events will be sent. Must be a valid HTTPS endpoint.
namestring
Name of the webhook for identification purposes.
fieldsobject
Comma-separated list(s) of attributes to include in the response. Keys are resource types, values are comma-separated attribute names.
includestring
A comma-separated list of relationship paths to include in the response.
webhook_idstringObligatorio
Webhook's ID (starts with 'wbh_').
api_versionstring
API version to use for this webhook. If not specified, uses the account's default version.
descriptionstring
Human-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_inflectionstringenum
Determines casing for the API response.
camelkebabsnake
payload_filterobject
Filter configuration to limit which events trigger the webhook based on payload attributes.
idempotency_keystring
Ensures the request is idempotent. Use the same key for duplicate requests.
persona_versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18
api_key_inflectionstring
Casing format for API keys in webhook payload (camel, kebab, or snake).
custom_http_headersobject
Custom 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_ininteger
Duration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Generic DocumentPERSONA_UPDATE_DOCUMENT_GENERICAcción

Tool 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

dataobjectObligatorio
Document data containing attributes to update.
fieldsobject
Comma-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
includestring
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See https://docs.withpersona.com/serialization#inclusion-of-related-resources
document-idstringObligatorio
The unique identifier of the generic document to update.
Key-Inflectionstringenum
Determines casing for the API response.
camelkebabsnake
Idempotency-Keystring
Ensures the request is idempotent. Use the same key for retries. Sent as header.
Persona-Versionstringenum
Server API version.
2025-12-082025-10-272023-01-052022-09-012021-08-182021-07-052021-02-212020-05-18

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not