Skip to content
Changelog

Report a bug

Persona integration: operations for AI agents

Persona connects to Type.com as an integration. This page lists the 221 operations documented for Claude and Codex in Type.com: 87 read, 103 write, 31 destructive.

About Persona

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

Categories: Security & Identity

How to connect Persona to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

221 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

221 operations listed.

Account Types

  • Read

    Retrieve an Account Type

    Retrieves the details of an existing Account Type, including its configured field schemas.

Accounts

  • Read

    List all Accounts

    Returns a list of your organization's account(s). Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an Account

    Retrieves the details of an existing Account.

  • Read

    Get all relations for an Account

    Gets relations for an Account by key

  • Read

    Search Accounts

    Search for accounts using a flexible query language. Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics.

  • Write

    Create an Account

    Creates a new Account for your organization.

  • Write

    Update an Account

    Updates an existing Account.

  • Write

    Add Persona objects to an Account

    Adds Persona objects (such as inquiries, documents, or reports) to an Account. To link an Account to another Account or a Transaction, use add-relation instead.

  • Write

    Add a relation to an Account

    Adds a relation from an Account to a target Account or Transaction

  • Write

    Add tag to an Account

    Adds a new tag to an Account

  • Write

    Consolidate Accounts

    Consolidates several source Accounts' information into one target Account. Any Persona resource associated with the source Account will be transferred over to the destination Account. However, the Account's attributes will not be transferred.

  • Write

    Set tags on an Account

    Sets all tags on an Account. Any tags that are not provided in the request will be removed.

  • Write

    Run an account action

    Triggers an account action for the specified account

  • Destructive

    Redact an Account

    Permanently deletes personally identifiable information (PII) for an Account and all associated Inquiries, Verifications and Reports. The response indicates a successful redaction of the Account.

  • Destructive

    Remove Persona objects from an Account

    Removes Persona objects (such as inquiries, documents, or reports) from an Account. This operation is idempotent — removing an object that is not attached succeeds without modifying the account.

  • Destructive

    Remove a relation from an Account

    Removes a relation from an Account to a target Account or Transaction.

  • Destructive

    Remove tag from an Account

    Removes an existing tag from an Account

API Keys

  • Read

    List all API keys

    Returns a list of your organization's API keys. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an API key

    Retrieves the information for an existing API key. The plaintext value is only returned when creating or cloning an API key.

  • Write

    Create an API key

    Creates a new API key with response defaults and permissions.

  • Write

    Update an API key

    Updates an existing API key.

  • Write

    Expire an API key

    Deactivates an API key within some time period

  • Write

    Clone an API key

    Creates a copy of an existing API key. All attributes except the value are copied over to the new API key.

Connect

  • Read

    List all Connections

    Returns a list of connect connections associated with your organization, including both outbound connections your organization created and inbound connections where your organization is the destination.

  • Read

    Retrieve a Connection

    Retrieves the details of an existing Connection.

  • Read

    List all Share Tokens

    Returns a list of your organization's Share Tokens. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Share Token

    Retrieve the information for an existing Share Token.

  • Write

    Create a Connection

    Creates a new Connection from your organization to a destination organization in the pending state. The destination organization must accept the connection before it transitions to active; share tokens cannot be redeemed through the connection until then.

  • Write

    Deactivate a Connection

    Deactivates a Connection. Either the source or destination organization may deactivate a connection that is currently pending or active. Deactivation prevents further access through the connection but maintains the connection record.

  • Write

    Reactivate a Connection

    Reactivates an inactive Connection, returning it to the pending state. Only the source organization can reactivate a connection. Once reactivated, the destination organization must accept the connection again before it returns to the active state.

  • Write

    Create a Share Token

    Creates a new Share Token with the specified connection and source. Share Tokens can be created from Accounts, Inquiries, Transactions, or Verifications.

  • Write

    Expire a Share Token

    Expires a Share Token, setting its status to expired and preventing further use.

  • Write

    Redeem a Share Token

    Initiates redemption of a Share Token in one of two modes: - Clone: Omit data.attributes.destination-id to create a new object from the source. Inquiry and Verification Share Tokens can be cloned.

API Logs

  • Read

    List all API Logs

    Returns a list of your organization's API Logs. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an API Log

    Retrieves the details of an existing API Log.

Importers

  • Read

    Retrieve a Batch Job

    Retrieve the status and counts for an existing Batch Job.

  • Read

    Retrieve Batch Job errors

    Retrieve global and per-row errors for an existing Batch Job.

  • Read

    List all Importers

    Returns a list of your organization's importers. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an Importer

    Retrieve the details of an existing importer.

  • Write

    Create a Batch Job

    Submits a batch of rows to update or upsert Accounts, or update Inquiries, in bulk. Persona processes the rows asynchronously as a Batch Job; poll the returned job or retrieve its errors to check progress.

  • Write

    Import Accounts

    Bulk import accounts by uploading a CSV file. Each row should be the details for a new account. The columns we allow are: - referenceid - namefirst - namemiddle - namelast - birthdate - socialsecuritynumber - tags

  • Write

    Import Email Address Lists

    Bulk import email address List Items by uploading a CSV file. Each row should be the details for a new List Item.

  • Write

    Import Geolocation Lists

    Bulk import geolocation List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - latitude - longitude - radiusmeters

  • Write

    Import Government ID Number Lists

    Bulk import government ID number List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - idnumber - idclass Common values for idclass include pp for passport and dl for driver license.

  • Write

    Import IP Address Lists

    Bulk import IP address List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - value Both IPv4 and IPv6 are supported.

  • Write

    Import Name Lists

    Bulk import name List Items by uploading a CSV file. Each row should be the details for a new list item. The columns we allow are: - namefirst - namelast

  • Write

    Import Phone Number Lists

    Bulk import phone number List Items by uploading a CSV file. Each row should be the details for a new list item. The columns we allow are: - value

Case Templates

  • Read

    Retrieve a Case Template

    Retrieves the details of an existing Case Template, including its configured field schemas.

Cases

  • Read

    List all Cases

    Returns a list of your organization's cases. Note that this endpoint aggregates cases across all case template(s). See Paginationfor more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Case

    Retrieves the details of an existing Case.

  • Read

    Search Cases

    Search for cases using a flexible query language. Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics.

  • Write

    Create a Case

    Creates a new case in your organization.

  • Write

    Update a Case

    Updates the fields and add attachments on a Case that has been previously created.

  • Write

    Add Persona objects to a Case

    Adds Persona objects (such as inquiries, accounts, or reports) to a Case

  • Write

    Assign a Case

    Assigns a Case to a Persona user.

  • Write

    Set status on a Case

    Sets the status of a Case.

  • Write

    Add tag to a Case

    Adds a new tag to a Case

  • Write

    Set tags on a Case

    Sets all tags on a Case. Any tags that are not provided in the request will be removed.

  • Write

    Add comment to a Case

    Adds a comment to a Case

  • Destructive

    Redact a Case

    Permanently redacts a Case and its fields. Case objects must be redacted individually. This action cannot be undone.

  • Destructive

    Remove Persona objects from a Case

    Removes Persona objects (such as inquiries, accounts, or reports) from a Case. This operation is idempotent — removing an object that is not attached succeeds without modifying the case.

  • Destructive

    Remove tag from a Case

    Removes an existing tag from a Case

Devices

  • Read

    List all Devices

    Retrieves a list of Devices. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Device

    Retrieves details of a specific Device.

Deployments

  • Read

    List all Deployments

    Returns a list of your organization's deployments, newest first. Results are returned in reverse chronological order. Each deployment's routes carry the effective state as of that deployment — the newest route per (resource template, environment) key at or before it.

  • Read

    Retrieve a Deployment

    Retrieves a single deployment. Its routes carry the effective state as of it — the newest route per (resource template, environment) key at or before the deployment, across every environment and template — including routes written by earlier deployments.

Documents

  • Read

    Retrieve a Generic Document

    Retrieves the details of a generic document that has been previously created.

  • Read

    Retrieve a Government Id Document

    Retrieves the details of a government-id document that has been previously created.

  • Read

    Retrieve a Document

    Retrieves the details of a Document.

Events

  • Read

    List all Events

    Returns a list of your organization's events. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an Event

    Retrieves the details of an existing event.

Graph

  • Read

    Retrieve a Graph Query

    Retrieve a Graph Query

  • Write

    Create a Graph Query

    Create a Graph Query

Inquiries

  • Read

    List all Inquiries

    Returns a list of your organization's inquiries. Note that this endpoint aggregates inquiries across all inquiry template(s). See Pagination for more details about handling the response.

  • Read

    Retrieve an Inquiry

    Retrieves the details of an existing Inquiry. In the Embedded Flow, the inquiry-id is the first parameter of the onStart callback. In the Hosted Flow, the inquiry-id is a query parameter in the onComplete callback.

  • Read

    Search Inquiries

    Search for inquiries using a flexible query language. Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics.

  • Write

    Create an Inquiry

    Creates a new inquiry with optional pre-filled attributes. See Sessions for how to continue the inquiry in Embedded Flow or Hosted Flow.

  • Write

    Update an Inquiry

    Updates an existing Inquiry. Note that if you use webhooks, updates to inquiries that are not in progress can result in data getting out of sync. For example, updating a completed Inquiry will not cause your Inquiry completed webhook to retrigger.

  • Write

    Add tag to an Inquiry

    Adds a new tag to an Inquiry.

  • Write

    Approve an Inquiry

    Approves an Inquiry. Note that this action will trigger any associated workflows and webhooks. Approving an inquiry will prevent further progress on the inquiry.

  • Write

    Decline an Inquiry

    Declines an Inquiry. Note that this action will trigger any associated workflows and webhooks. Declining an inquiry will prevent further progress on the inquiry.

  • Write

    Mark an Inquiry for manual review

    Marks an Inquiry for manual review. Inquiries that are already approved or declined cannot be marked for review. Note that this action will trigger any associated workflows and webhooks. Marking an inquiry for review will prevent further progress on the inquiry.

  • Write

    Expire an Inquiry

    Expires an Inquiry and all sessions on the Inquiry. Cancels any pending Verifications on the inquiry. The Inquiry can still be resumed after expiry.

  • Write

    Resume an Inquiry

    Creates a session token that is returned as meta.session-token. If the inquiry's status is expired, changes the status to pending. The session-token must be included when loading the inquiry flow if the inquiry's status is pending.

  • Write

    Set tags on an Inquiry

    Sets all tags on an Inquiry. Any tags that are not provided in the request will be removed.

  • Write

    Perform Simulate Actions

    Performs a series of simulated actions on a Sandbox Inquiry.

  • Destructive

    Redact an Inquiry

    Permanently deletes personally identifiable information (PII) for an Inquiry and all associated Verifications, Reports, or other Persona resources. The response indicates a successful redaction of the Inquiry.

  • Destructive

    Remove tag from an Inquiry

    Removes an existing tag from an Inquiry.

Inquiry Sessions

  • Read

    List all Inquiry Sessions

    Retrieves a list of Inquiry Sessions. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve an Inquiry Session

    Retrieves details of a specific Inquiry Session.

  • Write

    Create an Inquiry Session

    Creates a new Inquiry Session. By default, we only allow up to 25 sessions per Inquiry.

  • Write

    Expire Inquiry Sessions

    Expires all active Inquiry Sessions for a given set of Inquiries.

  • Write

    Expire an Inquiry Session

    Expires a specific Inquiry Session.

Inquiry Templates

  • Read

    List all Inquiry Template Versions

    Retrieves the published versions and current draft version of an Inquiry Template. Use a production API key and provide the Inquiry Template ID in filter[inquiry-template-id]. For security reasons, Inquiry Template Versions are not available in Sandbox.

  • Read

    List all Inquiry Templates

    Retrieves a list of your organization's Inquiry Templates. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API.

  • Read

    Retrieve an Inquiry Template

    Retrieves details of a specific Inquiry Template by ID. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API.

  • Read

    Retrieve Inquiry Template Translations

    Retrieves the translations for an Inquiry Template as a JSON:API resource. The export uses the latest draft version if one exists, otherwise falls back to the latest published version. Note: You must use a production API key to access this endpoint.

  • Write

    Import Inquiry Template Translations

    Imports translations for an Inquiry Template. Supports partial updates — translation rows not included in the request body are left unchanged. If a draft version already exists, translations are applied to it.

List Items

  • Read

    Retrieve a Browser Fingerprint List Item

    Retrieves the details of an existing browser fingerprint List Item.

  • Read

    Retrieve a Country List Item

    Retrieves the details of an existing country List Item.

  • Read

    Retrieve a Device Fingerprint List Item

    Retrieves the details of an existing device fingerprint List Item.

  • Read

    Retrieve an Email Address List Item

    Retrieves the details of an existing email address List Item.

  • Read

    Retrieve a Field List Item

    Retrieves the details of an existing field List Item.

  • Read

    Retrieve a Geolocation List Item

    Retrieves the details of an existing geolocation List Item.

  • Read

    Retrieve a Government ID Number List Item

    Retrieves the details of an existing government ID number List Item.

  • Read

    Retrieve an IP Address List Item

    Retrieves the details of an existing IP address List Item.

  • Read

    Retrieve a Name List Item

    Retrieves the details of an existing name List Item.

  • Read

    Retrieve a Phone Number List Item

    Retrieves the details of an existing phone number List Item.

  • Read

    Retrieve a String List Item

    Retrieves the details of an existing string List Item.

  • Write

    Create a Browser Fingerprint List Item

    Create a new item in a list.

  • Write

    Create a Country List Item

    Create a new item in a list.

  • Write

    Create a Device Fingerprint List Item

    Create a new item in a list.

  • Write

    Create an Email Address List Item

    Create a new item in a list.

  • Write

    Create a Field List Item

    Create a new item in a list.

  • Write

    Create a Geolocation List Item

    Create a new item in a list.

  • Write

    Create a Government ID Number List Item

    Create a new item in a list.

  • Write

    Create an IP Address List Item

    Create a new item in a list.

  • Write

    Create a Name List Item

    Create a new item in a list.

  • Write

    Create a Phone Number List Item

    Create a new item in a list.

  • Write

    Create a String List Item

    Create a new item in a list.

  • Destructive

    Archive a Browser Fingerprint List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Country List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Device Fingerprint List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive an Email Address List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Field List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Geolocation List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Government ID Number List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive an IP Address List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Name List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a Phone Number List Item

    Archived items are not matched against new inquiries.

  • Destructive

    Archive a String List Item

    Archived items are not matched against new inquiries.

Lists

  • Read

    List all Lists

    Returns a list of your organization's lists. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a List

    Retrieves the details of an existing list.

  • Write

    Create a Browser Fingerprint List

    Create a new list for your organization.

  • Write

    Create a Country List

    Create a new list for your organization.

  • Write

    Create an Email Address List

    Create a new list for your organization.

  • Write

    Create a Geolocation List

    Create a new list for your organization.

  • Write

    Create a Government ID Number List

    Create a new list for your organization.

  • Write

    Create an IP Address List

    Create a new list for your organization.

  • Write

    Create a Name List

    Create a new list for your organization.

  • Write

    Create a Phone Number List

    Create a new list for your organization.

  • Write

    Create a Strings List

    Create a new list for your organization.

  • Destructive

    Archive a List

    Archive an existing list. Archived lists are still retrievable, but will no longer match on inquiries.

OAuth

  • Write

    Create Authorization

    Authorizes another Organization to access your Inquiry, Verifications, or other Persona resources.

  • Write

    Create Access Token

    Exchange a credential for an access token. Supports two grant types: - authorizationcode: Exchange an authorization code for an access token (cross-org data sharing).

Relay

  • Write

    Create a Privacy Pass

    Issues a Privacy Pass token by blind-signing a client-provided blinded token (Blind RSA, RFC 9578). The returned blind signature is unblinded client-side to produce a Privacy Pass token that can later be redeemed anonymously (for example, when generating a Relay claim).

  • Write

    Create a Relay

    Creates a new Relay.

  • Write

    Request a Relay challenge

    Requests a Privacy Pass challenge for a claim type. The challenge materials returned here are used to obtain a Privacy Pass token, which is then redeemable to read claims from Relays with the same claim type.

  • Write

    Generate a Relay claim

    Returns a relay's claim.

Rate Limits

  • Read

    List all Rate Limits

    Returns a list of your current rate limits.

Reports

  • Read

    List all Reports

    Returns a list of all your organization's Reports. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Report

    Retrieves the details of an existing Report.

  • Read

    List Report history

    Retrieves the history of an existing Report, including runs and actions. See Pagination for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.

  • Write

    Create a Report

    Creates a new Report of any type.

  • Write

    Add tag to a Report

    Adds a new tag to the Report

  • Write

    Report Action: Dismiss Matches

    Dismisses active matches for supported report types

  • Write

    Report Action: Pause Continuous Monitoring

    Pauses continuous monitoring on a report. Requires additional permissions.

  • Write

    Report Action: Resume Continuous Monitoring

    Resumes continuous monitoring on paused report. Requires additional permissions.

  • Write

    Report Action: Review Matches

    Records a review decision on the matches of a Screening report. Review either every matched record at once, or a single matched record by its token from matched-records.

  • Write

    Report Action: Re-run Report

    Re-runs a continuously monitored report immediately, outside of its existing recurrence schedule.

  • Write

    Set tags on a Report

    Sets all tags on a Report. Any tags that are not provided in the request will be removed.

  • Destructive

    Redact a Report

    Permanently deletes personally identifiable information (PII) for a Report. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy.

  • Destructive

    Remove tag from a Report

    Removes an existing tag from a Report.

Theme Sets

  • Read

    List all Theme Sets

    Returns a list of your organization's theme sets. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Theme Set

    Retrieves the details of an existing theme set.

  • Write

    Create a Theme Set

    Creates a new theme set. The data attribute carries the nested theme tree (settings / light / dark) — the same shape as the Code-First theme-set YAML. Style cells that are not supported are rejected with a 400 naming each offending path.

  • Write

    Update a Theme Set

    Updates an existing theme set. Both attributes are optional — an omitted attribute is left unchanged.

  • Destructive

    Archive a Theme Set

    Archive an existing theme set. Archived theme sets are still retrievable, but can no longer be assigned to inquiry templates. Archiving also detaches the theme set from any inquiry templates it is assigned to — live flows fall back to default styling.

Transactions

  • Read

    List all Transactions

    Returns a list of your organization's transactions. Note that this endpoint aggregates transactions across all transaction type(s). See Pagination for more details about handling the response.

  • Read

    Retrieve a Transaction

    Retrieves the details of an existing Transaction.

  • Write

    Create a Transaction

    Creates a new Transaction for a specific transaction type in your organization.

  • Write

    Update a Transaction

    Updates a Transaction that has been previously created.

  • Write

    Add Persona objects to a Transaction

    Adds Persona objects (such as inquiries or verifications) to a Transaction. To link a Transaction to an Account or another Transaction, use add-relation instead.

  • Write

    Add relation to Transaction

    Adds a relation between this Transaction and a target Account or Transaction using a relation schema key. No effect if the relation already exists.

  • Write

    Add tag to Transaction

    Adds a tag to a Transaction. Create a new tag if the tag does not already exist. No effect if the transaction already has the tag.

  • Write

    Create a Transaction label

    Create a new label for an existing Transaction.

  • Write

    Sets tags on a Transaction

    Set the list of tags on a transaction. Remove all tags on the transaction that don't appear on the list. Add all tags on the transaction from the list.

  • Destructive

    Redact a Transaction

    Permanently deletes personally identifiable information (PII) for a Transaction. The response indicates a successful redaction of the Transaction.

  • Destructive

    Remove Persona objects from a Transaction

    Removes Persona objects (such as inquiries or verifications) from a Transaction. This operation is idempotent — removing an object that is not attached succeeds without modifying the transaction.

  • Destructive

    Remove relation from Transaction

    Removes a relation between this Transaction and a target Account or Transaction. No effect if the relation does not exist.

  • Destructive

    Remove tag from a Transaction

    Remove a tag from a transaction. No effect if the transaction does not have the tag.

  • Destructive

    Redact Transaction biometrics

    Permanently deletes biometric data for a Transaction AND all its associated objects. This action cannot be undone.

Transaction Types

  • Read

    Retrieve a Transaction Type

    Retrieves the details of an existing Transaction Type.

User Audit Logs

  • Read

    List all User Audit Logs

    Returns a list of your organization’s user audit logs for up to the most recent 6 months. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like user audit logs in Sandbox via API.

  • Read

    Retrieve a User Audit Log

    Retrieves the details of an existing user audit logs for up to the most recent 6 months. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like user audit logs in Sandbox via API.

AAMVA Verifications

  • Read

    Retrieve an AAMVA Verification

    Retrieve an AAMVA verification

E CBSV Database Verifications

  • Read

    Retrieve an eCBSV Database Verification

    Retrieve an eCBSV database verification

Phone Carrier Database Verifications

  • Read

    Retrieve a Phone Carrier Database Verification

    Retrieve a phone carrier database verification

Serpro Database Verifications

  • Read

    Retrieve a Serpro Database Verification

    Retrieve a Serpro database verification

Database Standard Verifications

  • Read

    Retrieve a Database Standard Verification

    Retrieve a database standard verification

TIN Database Verifications

  • Read

    Retrieve a TIN Database Verification

    Retrieve a TIN database verification

Database Verifications

  • Read

    Retrieve a Database Verification

    Retrieve a database verification

Document Verifications

  • Read

    Retrieve a Document Verification

    Retrieves the details of a specific document verification

Email Address Verifications

  • Read

    Retrieve an Email Address Verification

    Retrieve a email address verification

Government ID Verifications

  • Read

    Retrieve a Government ID Verification

    Retrieve a government ID verification

Government ID NFC Verifications

  • Read

    Retrieve a Government ID NFC Verification

    Retrieve a Government ID NFC verification

Phone Number Verifications

  • Read

    Retrieve a Phone Number Verification

    Retrieve a phone number verification

Selfie Verifications

  • Read

    Retrieve a Selfie Verification

    Retrieve a selfie ID verification

Verifications

  • Read

    Retrieve a Verification

    Retrieves the details of an existing Verification.

  • Write

    Investigation Lock a Verification

    Locks a Verification from redaction while it is under investigation. While locked, redaction requests for the Verification will be rejected.

  • Write

    Investigation Unlock a Verification

    Unlocks a Verification that was previously locked from redaction during an investigation.

  • Destructive

    Redact a Verification

    Permanently deletes personally identifiable information (PII) for a Verification. This action cannot be undone. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy.

Webhook Events

  • Read

    Search Webhook Events

    Search for webhook events using a flexible query language. Webhook events are the individual delivery records for your webhooks — one per event, per webhook.

Webhooks

  • Read

    List all Webhooks

    Returns a list of your environment's webhooks. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    Retrieve a Webhook

    Retrieves the details of an existing webhook, including its secret.

  • Write

    Create a Webhook

    Creates a new webhook with response defaults.

  • Write

    Update a Webhook

    Updates an existing Webhook.

  • Write

    Enable a Webhook

    Enables a webhook.

  • Write

    Disable a Webhook

    Disables a webhook.

  • Write

    Rotate a Webhook's secret

    Rotates a webhook's secret by creating a new secret. The old secret stays active for the number of seconds you pass in meta.expires-in-seconds.

  • Write

    Clone a Webhook

    Creates a copy of an existing webhook. All attributes except the secret are copied over to the new webhook.

  • Destructive

    Archive a Webhook

    Archives a webhook.

Workflows

  • Read

    Retrieve a Workflow Run

    Retrieves the details of an existing workflow run.

  • Read

    List all Workflow Runs

    Returns a list of your environment's workflow runs. Results are returned in reverse chronological order, with the most recently created objects first.

  • Read

    List all Workflow Versions

    Retrieves the published versions and current draft version of a Workflow. Archived versions are not returned. Provide the Workflow ID in filter[workflow-id], which you can copy from the Workflow in your Persona dashboard.

  • Write

    Create a Workflow Run

    Creates a new Workflow Run. Note: The payload is arbitrary and defined by the Workflow version trigger schema.

See How connections work for access and permissions, or browse all integrations.