Reference

Create an Account

Sets up a new account in Persona with customer information including name, email, phone, and address details. Use this to register new customers or contacts in your system.

List All Accounts

Retrieve all accounts in your Persona system with optional filtering by reference ID or account type, helping you manage and organize your contact database.

Search Accounts

Find specific customer or business accounts in Persona by filtering with flexible criteria like attributes, tags, or status. This helps you quickly locate the accounts you need to work with without manual searching.

Set Tags on Account

Organize and categorize your Persona account with custom tags to keep your customer records organized and easy to find. Tags replace all existing ones, making it simple to update your account organization system.

Update an Account

Modify and keep your customer account information current in Persona, including contact details, addresses, and custom fields to maintain accurate records.

Add Tag to Account

Organize and categorize your customer accounts by applying labels or tags for better account management and segmentation. This helps you quickly identify and group accounts based on characteristics, status, or business needs.

Consolidate Accounts

Merge multiple duplicate or related accounts into a single primary account, consolidating all data and activity into one unified record.

Redact an Account

Permanently removes sensitive personal information from a Persona account to comply with privacy regulations and data protection laws. This action is irreversible and ensures compliance with requests to delete customer data.

Remove Account Tag

Remove a tag from a customer account in Persona to keep your contact database organized and up-to-date. This helps you maintain accurate customer classifications and remove outdated categorizations.

Retrieve an Account

Fetch complete details of a specific account by its ID to access customer information, communication history, and account status in one request.

List All Cases

Retrieve all cases from your Persona system with optional filtering and pagination to organize and track your customer interactions and support tickets.

Search Cases

Find specific customer cases or support tickets by applying filters and search criteria to quickly locate relevant issues. This helps you retrieve only the cases that match your current needs without manual searching.

List All Devices

Retrieve all devices associated with a specific customer inquiry session to understand what devices they're using or asking about.

Create Generic Document

Creates a new document record in your account or client inquiry, allowing you to organize and store different types of documents for reference and management.

Retrieve a Document

Fetch the details and content of a specific document stored in Persona by providing its ID, allowing you to access previously saved files, records, or communications.

Retrieve Generic Document

Fetches the details and content of a specific document by its ID, allowing you to access important files and information stored in your Persona system.

Update Generic Document

Modify an existing document in Persona by updating its fields, files, or document type, enabling you to correct information or reorganize client records without creating duplicates.

List all Events

Retrieve all events from your Persona account, including support for filtering and pagination to help you access communication history and organization activity.

Retrieve an Event

Fetch detailed information about a specific event that was logged in Persona, including its properties, timing, and associated data.

List all Importers

Retrieve a complete list of all data importers configured in your Persona account, including those for accounts, email lists, and other data sources. This helps you track and manage all active import operations in one place.

Retrieve an Importer

Fetch detailed information about a specific import operation in Persona by its ID, including status, configuration, and results. Use this to track the progress of your data imports or troubleshoot import issues.

List All Inquiries

Retrieve a complete list of all inquiries from your Persona account with optional filtering by status, account, or other criteria. This helps you manage and track customer communications in one place.

Expire Inquiry Sessions

Instantly terminate multiple inquiry sessions by providing their IDs, allowing you to close conversations and free up your capacity to handle new customer inquiries.

List All Inquiry Sessions

Retrieve all your customer inquiry sessions in one place, with optional filtering to find specific conversations or track communication history.

Archive a Geolocation List Item

Safely remove a geolocation entry from your active lists while keeping the historical record intact, allowing you to clean up your location data without permanent loss.

Archive a Name List Item

Removes a contact from your active name list by archiving it, keeping your contact database organized and up-to-date without permanent deletion.

Archive Browser Fingerprint List Item

Marks a browser fingerprint list item as archived in Persona, allowing you to remove it from active use while preserving the historical record for compliance or future reference.

Archive Country List Item

Mark a country list item as archived to remove it from active use without permanently deleting it. This helps keep your country lists organized and up-to-date.

Archive Email Address List Item

Move an email address or domain from an active list to archived status, keeping your contact lists clean and organized without permanently deleting entries. This helps maintain list hygiene while preserving historical data for compliance or reference.

Archive Government ID Number List Item

Removes a government ID number from your active records by archiving it, keeping your documentation clean while maintaining historical records.

Archive IP Address List Item

Remove an IP address from your active monitoring list by archiving it, useful when that address is no longer relevant to your security or communication needs.

Archive Phone Number List Item

Mark a phone number list item as archived in Persona to remove it from active use while preserving the data for future reference.

Archive String List Item

Mark a string list item as archived to remove it from active use without permanently deleting it, useful for maintaining clean records while preserving historical data. This keeps your lists organized and makes it easy to restore items if needed.

Create Country List Item

Add a country to your identity verification or compliance list in Persona, enabling you to manage which countries you accept or verify for your business operations.

Create Email Address List Item

Add email addresses to watchlists or blocklists in Persona to manage communications and filter contacts based on your business needs. This helps you organize and control which emails you actively monitor or want to exclude.

Create Government ID Number List Item

Add government ID numbers like SSNs, passports, or driver's licenses to monitoring lists for compliance and risk management purposes.

Create IP Address List Item

Add IP addresses to your identity verification watchlists or allowlists to control which devices or locations can access your services or complete verification processes.

Create Name List Item

Add a person's name to a specific list in Persona for verification, monitoring, or organizational purposes. This helps you maintain organized records of contacts or individuals relevant to your business needs.

Create Phone Number List Item

Adds a phone number to a designated list in Persona for organizing and tracking contact information. Use this when you need to build contact lists for outreach, verification, or customer segmentation purposes.

Create String List Item

Add new text values to existing lists in Persona for filtering, matching, or organizing data used in your communication workflows.

Import Email Address Lists

Bulk upload email addresses from a CSV file into a list for identity verification or organizational purposes. This streamlines the process of managing large groups of email contacts without manual entry.

Import IP Address Lists

Bulk upload IPv4 or IPv6 addresses into your Persona IP address lists for managing network security, access control, and communication filtering across your organization.

Import Name Lists

Import multiple names into Persona for identity verification and customer validation purposes. Streamline the process of adding large groups of names to your existing name lists.

Import Phone Number Lists

Bulk upload phone numbers in E.164 format to your existing contact lists in Persona for organizing and managing communication outreach.

List All Lists

Retrieve all lists from your Persona account to view your complete collection of audience segments, contact groups, or distribution lists in one place.

Retrieve a Country List Item

Fetches details about a specific country from your Persona database, allowing you to access stored information like country codes, names, or custom attributes associated with that country record.

Retrieve a Geolocation List Item

Fetch detailed information about a specific location entry stored in your geolocation list, such as coordinates, address, or associated metadata. This helps you access and verify location data you've previously saved for your customers or operational sites.

Retrieve a Name List Item

Fetch detailed information about a specific contact or entry from your Persona name list, including names, status, and match data to verify or review individual records.

Retrieve a String List Item

Fetches a specific item from your Persona string list using its ID, allowing you to retrieve stored information when needed. This is useful when you need to access individual contact details, preferences, or other list items for your outreach or communication activities.

Retrieve Browser Fingerprint List Item

Fetch detailed information about a specific browser fingerprint profile stored in your Persona system to verify user identity or investigate suspicious account activity.

Retrieve Email Address List Item

Retrieves detailed information about a specific email address in your contact list, including its status, validation state, and engagement metrics.

Retrieve Government ID Number List Item

Fetch detailed information about a specific government ID number entry in your Persona system, including its classification, verification status, and tracking metrics. Use this to verify individual ID records and monitor their activity history.

Retrieve IP Address List Item

Fetch detailed information about a specific IP address from your Persona list, including its status, how many times it matched, and when it was added or updated.

Retrieve Phone Number List Item

Fetches details of a specific phone number from your Persona list, enabling you to verify contact information or check fraud history for a particular entry.

List All API Logs

Retrieve a complete history of API requests made to your Persona account, including details like request status, response codes, and timestamps to track system activity and troubleshoot integration issues.

Retrieve an API Log

Fetch details of a specific API request or response that was logged in Persona to review transaction history, troubleshoot integration issues, or audit communication records.

List All Reports

Retrieve all reports from your Persona account with optional filtering and pagination to manage adverse media, watchlist, profile, and verification reports in one place.

List All Rate Limits

Retrieve current rate limit information for your API usage to understand your API quota and usage constraints. Use this to monitor how much capacity you have remaining before hitting limits.

List All Transactions

Retrieve all transactions from your Persona account with optional filtering to track payments, transfers, and financial activity across your organization.

Create Webhook

Set up real-time notifications that automatically send updates to your application whenever specific events occur in your Persona account, enabling automated workflows and instant alerts.

List All Webhooks

Retrieve all webhooks configured for your Persona account to see what automated integrations and event notifications are currently active. This helps you manage and monitor real-time data synchronization with external tools and services.

Archive a webhook

Deactivate a webhook while preserving its history and configuration for future reference, without permanently deleting it.

Clone Webhook

Duplicate an existing webhook configuration with all its original settings, allowing you to quickly replicate event notifications across different environments or workflows without manual setup.

Disable Webhook

Temporarily stop a webhook from receiving events while keeping its configuration intact, allowing you to pause integrations without losing setup details.

Enable Webhook

Activates a webhook in Persona to start receiving real-time notifications and automated updates for your business events. Use this when you need to resume receiving webhooks after they've been disabled.

Retrieve a Webhook

Fetch detailed information about a specific webhook configuration to review its settings, URL, and event triggers. This helps you verify webhook setup and troubleshoot integration issues without navigating through your dashboard.

Rotate Webhook Secret

Generate a new secret key for your webhook to enhance security and verify webhook signatures from Persona, with an optional transition period to keep the old secret working during the rotation.

Update a Webhook

Modify your webhook settings to change the destination URL, event types, or other configuration details without losing your existing webhook setup.

List all Workflow Runs

Retrieve a complete list of all workflow executions in Persona with optional filtering by workflow, inquiry, account, or session, helping you track automation progress and performance.