Persona offers identity infrastructure that allows you to craft personalized and automated verification solutions so you can better understand & protect users.
Persona offers identity infrastructure that allows you to craft personalized and automated verification solutions so you can better understand & protect users. On Nagent, Persona is exposed as a fully-configurable security & identity tools integration that any agent can call — 69 actions, and API key authentication. No code is required to wire Persona into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Persona to automate the kinds of tasks security & identity tools teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Persona into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Persona, with input parameters and output schema. Drop these into any step of an agent built in Helix.
PERSONA_ADD_TAG_TO_ACCOUNTTool 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.
Input parameters
Meta object containing tag information (tag_id or tag_name).
Comma-separated list(s) of attributes to include per resource type. See Persona API serialization docs.
A comma-separated list of relationship paths to include in the response (e.g., 'account-type').
The ID of the account to add the tag to.
Determines casing for the API response. Options: camel, kebab, snake.
Ensures the request is idempotent. Provide a unique key to prevent duplicate tag additions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_BROWSER_FINGERPRINT_LIST_ITEMTool 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.
Input parameters
Comma-separated list of relationship paths to include in the response.
ID of the browser fingerprint list item to archive. Must start with 'libf_'.
Determines casing for the API response.
Ensures the request is idempotent.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_COUNTRY_LIST_ITEMTool 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.
Input parameters
Comma-separated list of attributes to include in the response. Use to customize which attributes are serialized.
A comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
ID of list item to archive. Starts with 'lic_'.
Key inflection options for API response casing.
Ensures the request is idempotent. Provide a unique key to prevent duplicate processing.
Persona API version options.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_GEOLOCATION_LIST_ITEMTool 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.
Input parameters
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.
ID of list item to archive. Must start with 'ligl_' prefix.
Casing format for API response.
Ensures the request is idempotent. Optional header to prevent duplicate operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_GOVERNMENT_ID_NUMBER_LIST_ITEMTool to archive a Government ID Number List Item. Use when you need to remove a government ID number from the active list.
Input parameters
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.
ID of list item to archive. Starts with 'ligin_'.
Determines casing for the API response. Options: camel, kebab, snake.
Ensures the request is idempotent.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_NAME_LIST_ITEMTool to archive a name list item in Persona. Use when you need to archive a specific name list item by its ID.
Input parameters
ID of the name list item to archive. Starts with 'lin_'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_A_WEBHOOKTool 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.
Input parameters
Comma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
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's ID (starts with 'wbh_'). This is the unique identifier for the webhook to archive.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for retries to avoid duplicate operations.
API version to use for the request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_EMAIL_ADDRESS_LIST_ITEMTool 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.
Input parameters
Comma-separated list of attributes to include in the response. See Persona's Serialization documentation for sparse fieldsets.
A comma-separated list of relationship paths to include in the response. See Persona's Serialization documentation for details.
ID of list item to archive. Starts with 'liea_'.
Determines casing for the API response.
Ensures the request is idempotent.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_IP_ADDRESS_LIST_ITEMTool to archive an IP address list item in Persona. Use when you need to remove an IP address from active monitoring.
Input parameters
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.
ID of list item to archive. Starts with `liip_`.
Determines casing for the API response.
Ensures the request is idempotent.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_PHONE_NUMBER_LIST_ITEMTool 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.
Input parameters
Comma-separated list of relationship paths to include in the response.
ID of the phone number list item to archive. Must start with 'lipn_'.
Determines casing for the API response.
Ensures the request is idempotent.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ARCHIVE_STRING_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of list item to archive. Example: 'listr_qCSMQ2eh4ftToxJRunQtxHmksrC8'
Casing format for API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CLONE_WEBHOOKTool to clone an existing Persona webhook. Use when you need to duplicate a webhook configuration with all its settings.
Input parameters
Comma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
The ID of the webhook to clone. Must start with "wbh_".
Determines casing for the API response.
Ensures the request is idempotent. Use to safely retry requests.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CONSOLIDATE_INTO_ACCOUNTTool 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.
Input parameters
Comma-separated list of attributes to include in the response. Customizes which attributes will be serialized.
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
Destination Account ID to consolidate source accounts into.
Determines casing for the API response. Valid values: 'camel', 'kebab', 'snake'.
Ensures the request is idempotent. Provide a unique key to prevent duplicate consolidations.
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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_AN_ACCOUNTTool 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.
Input parameters
The account data to create.
Meta information for account creation.
A comma-separated list of relationship paths to include in the response.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_AN_IP_ADDRESS_LIST_ITEMTool 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.
Input parameters
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').
A comma-separated list of relationship paths to include in the response (e.g., 'creator').
The ID of the list to add the IP address to. Must start with 'lst_'.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple identical items.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_COUNTRY_LIST_ITEMTool 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.
Input parameters
Data object containing the country list item attributes.
Comma-separated list of attributes to include in the response (sparse fieldsets).
Comma-separated list of relationship paths to include in the response.
Determines casing for the API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate creations.
Server API version for Persona.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_DOCUMENT_GENERICTool 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.
Input parameters
Document data containing attributes for the generic document.
Comma-separated list of relationship paths to fully serialize in the 'included' key. See https://docs.withpersona.com/serialization#inclusion-of-related-resources
Casing format for API response.
Ensures the request is idempotent. Use the same key for retries.
API version for Persona.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_EMAIL_ADDRESS_LIST_ITEMTool to create an email address list item in Persona. Use when you need to add an email address to a watchlist or blocklist.
Input parameters
The email address value to add to the list.
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
The ID of the list to add the email address to. List IDs typically start with 'lst_'.
The type of match for the list item. Should be 'email_address' for email address list items.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for retries of the same request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_GOVERNMENT_ID_NUMBER_LIST_ITEMTool 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.
Input parameters
The data object containing the attributes for the list item.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_NAME_LIST_ITEMTool 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.
Input parameters
Data object containing the attributes for the name list item.
Comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
Casing style for API response keys.
Ensures the request is idempotent. Provide a unique key to prevent duplicate list item creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_PHONE_NUMBER_LIST_ITEMTool 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.
Input parameters
The data object containing attributes for the phone number list item.
A comma-separated list of relationship paths to include in the response. See Persona serialization docs for details.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key to prevent duplicate creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_STRING_LIST_ITEMTool to create a String List Item in Persona. Use when adding a new string value to an existing list for matching or filtering purposes.
Input parameters
The string value to add to the list.
Comma-separated list of relationship paths to include in the response. Customizes which related resources are fully serialized in the 'included' key.
The ID of the list to add the string item to. Must be a valid list ID starting with 'lst_'.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for retries to avoid creating duplicate items.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_CREATE_WEBHOOKTool 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.
Input parameters
Target URL where webhook events will be sent. Must be a valid HTTPS endpoint.
Name of the webhook for identification purposes.
Comma-separated list of attributes to include in the response for customization.
A comma-separated list of relationship paths to include in the response.
API version to use for this webhook. If not specified, uses the account's default version.
Human-readable description of the webhook's purpose.
List of event types that will trigger this webhook. Common events include 'account.created', 'inquiry.completed', 'verification.passed', etc.
Determines casing for the API response.
Filter configuration to limit which events trigger the webhook based on payload attributes.
Ensures the request is idempotent. Use the same key for duplicate requests to prevent creating multiple webhooks.
Persona API version.
Casing format for API keys in webhook payload (camel, kebab, or snake).
Custom HTTP headers to include in webhook requests for authentication or routing.
List of attributes to exclude from the webhook payload for security or data minimization.
Duration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_DISABLE_WEBHOOKTool to disable a webhook in Persona. Use when you need to stop a webhook from receiving events without deleting it.
Input parameters
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.
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's ID (starts with 'wbh_')
Casing options for API response.
Ensures the request is idempotent
Persona API version options.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ENABLE_WEBHOOKTool to enable a webhook in Persona. Use when you need to activate a previously disabled webhook.
Input parameters
A comma-separated list of relationship paths to include in the response
Webhook's ID (starts with 'wbh_')
Key inflection options for API response casing.
Ensures the request is idempotent
Persona API version options.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_EXPIRE_INQUIRY_SESSIONSTool 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.
Input parameters
Meta information containing the list of inquiry IDs to expire.
A comma-separated list of relationship paths to include in the response.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_IMPORT_EMAIL_ADDRESS_LISTSTool 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.
Input parameters
File object containing base64 encoded email addresses and filename. The CSV should have columns 'email_address' and 'match_type'.
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.
The ID of the list to import email addresses into. Must be a valid list ID starting with 'lst_'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_IMPORT_IP_ADDRESS_LISTSTool to import IP address lists into Persona. Use when you need to bulk upload IPv4 or IPv6 addresses to an existing list.
Input parameters
Data object containing import attributes
A comma-separated list of relationship paths to include in the response
Determines casing for the API response.
Ensures the request is idempotent. Use a unique key to prevent duplicate imports.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_IMPORT_NAME_LISTSTool 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.
Input parameters
Data object containing import attributes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_IMPORT_PHONE_NUMBER_LISTSTool to import phone number lists into Persona. Use when you need to bulk upload phone numbers in E.164 format to an existing list.
Input parameters
Data object containing import attributes
A comma-separated list of relationship paths to include in the response
Determines casing for the API response.
Ensures the request is idempotent. Use a unique key to prevent duplicate imports.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_ACCOUNTSTool 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.
Input parameters
Number of records to return per page.
Cursor for pagination - retrieves records after this cursor.
Cursor for pagination - retrieves records before this cursor.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter accounts by external reference ID.
Filter accounts by account type ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_API_LOGSTool 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.
Input parameters
Number of records to return per page.
Cursor for pagination - retrieves records after this cursor.
Cursor for pagination - retrieves records before this cursor.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_CASESTool to list all cases in Persona. Use when you need to retrieve a collection of cases with optional filtering and pagination.
Input parameters
Number of records to return per page.
Cursor for pagination. Fetch records after this cursor.
Comma-separated list of attributes to include for case resources.
Cursor for pagination. Fetch records before this cursor.
Filter cases by status (e.g., 'open', 'closed').
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter cases created on or before this timestamp (ISO 8601 format).
Filter cases created on or after this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_DEVICESTool to list all devices filtered by inquiry session ID. Use when you need to retrieve devices associated with a specific inquiry session.
Input parameters
Number of results per page. Default: 10, max: 100.
Cursor ID to fetch results after.
Cursor ID to fetch results before.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter devices by inquiry session ID (format: iqse_*).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_EVENTSTool 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.
Input parameters
Number of events to return per page. Must be between 1 and 100.
Cursor for forward pagination. The object ID that defines your place in the list. Use this to fetch the next page of results.
Cursor for backward pagination. The object ID that defines your place in the list. Use this to fetch the previous page of results.
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.
Casing format for API response.
Ensures the request is idempotent. Optional header to prevent duplicate operations.
Persona API version.
Filter events created after this timestamp. Use ISO 8601 format.
Filter events created before this timestamp. Use ISO 8601 format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_IMPORTERSTool 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.
Input parameters
Number of items to return per page. Default is determined by the API.
Cursor for pagination. Use the value from 'links.next' in the previous response to fetch the next page.
Cursor for pagination. Use the value from 'links.prev' in the previous response to fetch the previous page.
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_INQUIRIESTool 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.
Input parameters
Number of records to return per page.
Cursor for pagination - retrieves records after this cursor.
Cursor for pagination - retrieves records before this cursor.
Filter inquiries by status (e.g., 'pending', 'completed', 'expired').
Determines casing for the API response.
Comma-separated list of attributes to include for inquiry resources.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter inquiries by account ID.
Filter inquiries by external reference ID.
Filter inquiries by inquiry template ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_INQUIRY_SESSIONSTool to list all inquiry sessions in Persona. Use when you need to retrieve a collection of inquiry sessions with optional filtering.
Input parameters
Optional filter parameters to narrow down inquiry session results. Keys can include inquiry session attributes like 'inquiry-id', 'reference-id', 'status', etc.
Number of results per page. Default: 10, max: 100.
Cursor ID to fetch results after.
Cursor ID to fetch results before.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_LISTSTool to list all lists in Persona. Use when you need to retrieve a paginated collection of lists with optional filtering and field selection.
Input parameters
Number of records to return per page.
Cursor for pagination - retrieves records after this cursor.
Cursor for pagination - retrieves records before this cursor.
Filter parameters for the list query. Key-value pairs for filtering results.
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.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_RATE_LIMITSTool to list all rate limits in Persona. Use when you need to retrieve current rate limit information for your API usage.
Input parameters
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_REPORTSTool 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.
Input parameters
Number of records to return per page.
Cursor for pagination. Fetch records after this cursor.
Cursor for pagination. Fetch records before this cursor.
Comma-separated list of attributes to include for report resources.
Filter reports by status.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter reports by report template ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_TRANSACTIONSTool to list all transactions in Persona. Use when you need to retrieve a paginated collection of transactions with optional filtering.
Input parameters
Number of records to return per page.
Cursor for pagination. Fetch records after this cursor.
Cursor for pagination. Fetch records before this cursor.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Comma-separated list of attributes to include for transaction resources.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_WEBHOOKSTool to list all webhooks in Persona. Use when you need to retrieve a paginated list of webhooks configured for the account.
Input parameters
Number of records to return per page.
Cursor for pagination - retrieves records after this cursor.
Cursor for pagination - retrieves records before this cursor.
Determines casing for the API response.
Comma-separated list of attributes to include for webhook resources.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_LIST_ALL_WORKFLOW_RUNSTool 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.
Input parameters
Number of items to return per page. Defaults to API default if not specified.
Cursor for pagination to fetch records after this cursor.
Cursor for pagination to fetch records before this cursor.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Filter workflow runs by account ID.
Filter workflow runs by inquiry ID.
Filter workflow runs by workflow ID.
Comma-separated list of workflow-run attributes to include in the response.
Filter workflow runs by session token.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_REDACT_AN_ACCOUNTTool 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.
Input parameters
Comma-separated list(s) of attributes to include in the response. Use to customize which attributes will be serialized. Format: {'resource_type': 'field1,field2'}.
A comma-separated list of relationship paths to include in the response. Customizes which related resources will be fully serialized in the 'included' key.
The ID of the account to redact. Must be a valid account ID starting with 'act_'.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for retries to avoid duplicate operations.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_REMOVE_ACCOUNT_TAGTool 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.
Input parameters
Meta information containing either the tag ID or tag name to remove.
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.
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.
The ID of the account from which to remove the tag.
Determines casing for the API response. Options: camel, kebab, snake.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_A_COUNTRY_LIST_ITEMTool to retrieve a country list item by ID in Persona. Use when you need to fetch details of a specific country list item.
Input parameters
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
ID of the country list item to retrieve. Starts with 'lic_'.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_A_GEOLOCATION_LIST_ITEMTool to retrieve a geolocation list item from Persona. Use when you need to fetch details of a specific geolocation list item by its ID.
Input parameters
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.
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.
ID of list item to retrieve. Must start with 'ligl_' prefix.
Casing format for API response.
Ensures the request is idempotent. Optional header to prevent duplicate operations.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_AN_ACCOUNTTool to retrieve an account in Persona. Use when you need to fetch details of a specific account by its ID.
Input parameters
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.
Unique identifier for the account to retrieve.
Comma-separated list(s) of attributes to include in the response, keyed by resource type. This customizes which attributes will be serialized.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_A_NAME_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the name list item to retrieve. Must start with 'lin_'.
Casing format for API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_AN_EVENTTool to retrieve an event in Persona. Use when you need to fetch details of a specific event that was logged by Persona.
Input parameters
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.
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.
The unique identifier of the event to retrieve.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_AN_IMPORTERTool to retrieve a specific importer in Persona. Use when you need to get details about a specific import operation by its ID.
Input parameters
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.
String ID of the importer to retrieve.
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_AN_IP_ADDRESS_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the IP address list item to retrieve. Must start with 'liip_'.
Casing format for API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_API_LOGTool 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.
Input parameters
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.
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.
The unique identifier of the API log to retrieve.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_A_STRING_LIST_ITEMTool to retrieve a string list item by ID in Persona. Use when you need to fetch details of a specific string list item.
Input parameters
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Used for sparse fieldsets.
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the 'included' key in the response.
ID of the string list item to retrieve. Starts with 'listr_'.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_A_WEBHOOKTool to retrieve a webhook by its ID. Use when you need to fetch details about a specific webhook configuration.
Input parameters
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.
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's ID (starts with 'wbh_').
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_BROWSER_FINGERPRINT_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the browser fingerprint list item to retrieve. Starts with 'libf_'.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_DOCUMENTTool to retrieve a document from Persona. Use when you need to fetch details of a specific document by its ID.
Input parameters
A comma-separated list of relationship paths. Customizes which related resources will be fully serialized in the `included` key in the response.
The unique identifier of the document to retrieve.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_DOCUMENT_GENERICTool to retrieve a generic document in Persona. Use when you need to fetch details of a specific document by its ID.
Input parameters
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
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
The unique identifier of the generic document to retrieve.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_EMAIL_ADDRESS_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the email address list item to retrieve. Must start with 'liea_'.
Casing format for API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_GOVERNMENT_ID_NUMBER_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the government ID number list item to retrieve. Must start with 'ligin_'.
Casing format for API response.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Persona API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_RETRIEVE_PHONE_NUMBER_LIST_ITEMTool 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.
Input parameters
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.
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.
ID of the phone number list item to retrieve. Starts with 'lipn_'.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_ROTATE_WEBHOOK_SECRETTool 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.
Input parameters
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.
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's ID (starts with 'wbh_')
Casing options for API response.
Ensures the request is idempotent
Persona API version options.
Seconds until currently active webhook secret expires. If not specified, the old secret expires immediately upon rotation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_SEARCH_ACCOUNTSTool 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.
Input parameters
Pagination configuration.
Sort configuration for results.
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'}\]}
Comma-separated list(s) of attributes to include in the response, keyed by resource type. Allows customizing which attributes will be serialized.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_SEARCH_CASESTool 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.
Input parameters
Pagination parameters for search results.
Sort configuration for search results.
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'}
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_SET_TAGSTool 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.
Input parameters
Meta object containing tag information (tag_id or tag_name arrays).
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.
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.
The ID of the account to set tags on.
Key inflection options for API response casing.
Ensures the request is idempotent. Provide a unique key to prevent duplicate operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_UPDATE_AN_ACCOUNTTool 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.
Input parameters
The account data to update.
A comma-separated list of relationship paths to include in the response.
Unique identifier for the account to update.
Comma-separated list(s) of attributes to include in the response, keyed by resource type.
Determines casing for the API response.
Ensures the request is idempotent. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_UPDATE_A_WEBHOOKTool to update a webhook in Persona. Use when you need to modify webhook configuration such as name, description, URL, or enabled events.
Input parameters
Target URL where webhook events will be sent. Must be a valid HTTPS endpoint.
Name of the webhook for identification purposes.
Comma-separated list(s) of attributes to include in the response. Keys are resource types, values are comma-separated attribute names.
A comma-separated list of relationship paths to include in the response.
Webhook's ID (starts with 'wbh_').
API version to use for this webhook. If not specified, uses the account's default version.
Human-readable description of the webhook's purpose.
List of event types that will trigger this webhook. Common events include 'account.created', 'inquiry.completed', 'verification.passed', etc.
Determines casing for the API response.
Filter configuration to limit which events trigger the webhook based on payload attributes.
Ensures the request is idempotent. Use the same key for duplicate requests.
Server API version.
Casing format for API keys in webhook payload (camel, kebab, or snake).
Custom HTTP headers to include in webhook requests for authentication or routing.
List of attributes to exclude from the webhook payload for security or data minimization.
Duration in seconds for file access token expiration. Controls how long file URLs in webhook payloads remain valid.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSONA_UPDATE_DOCUMENT_GENERICTool to update a generic document in Persona. Use when you need to modify fields, files, or kind of an existing document by its ID.
Input parameters
Document data containing attributes to update.
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
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
The unique identifier of the generic document to update.
Determines casing for the API response.
Ensures the request is idempotent. Use the same key for retries. Sent as header.
Server API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 94 agents privately built on Nagent that already use Persona.
Build on Nagent
Connect Persona to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Persona, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Persona is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Persona is connected, you configure its 69 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Persona steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Persona event fires, the agent kicks off automatically.
Every Persona action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Persona ships with 69 pre-built security & identity tools actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Persona together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Persona-based workflows tailored to your business.