Persona

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. Redaction of the Account's associated child objects is done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. Note: An account is still updatable after redaction. If you want to delete data continuously, please reach out to us to help you setup a retention policy. via DELETE /accounts/{account-id}

Permanently redacts a Case and its fields. Case objects must be redacted individually. **This action cannot be undone**. via DELETE /cases/{case-id}

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. Redaction of the Inquiry's associated child objects are done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. via DELETE /inquiries/{inquiry-id}

Archived items are not matched against new inquiries. via DELETE /list-item/browser-fingerprints/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/countries/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/device-fingerprints/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/email-addresses/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/fields/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/geolocations/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/government-id-numbers/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/ip-addresses/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/names/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/phone-numbers/{list-item-id}

Archived items are not matched against new inquiries. via DELETE /list-item/strings/{list-item-id}

Archive an existing list. Archived lists are still retrievable, but will no longer match on inquiries. via DELETE /lists/{list-id}

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. Note that this will only delete the report -- it does not delete associated accounts, inquiries, verifications, or other Persona resources. via DELETE /reports/{report-id}

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. The organization's default theme set cannot be archived and returns a 409. via DELETE /theme-sets/{theme-set-id}

Permanently deletes personally identifiable information (PII) for a Transaction. The response indicates a successful redaction of the Transaction. Redaction of the Transaction's associated child objects is done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. via DELETE /transactions/{transaction-id}

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. via DELETE /verifications/{verification-id}

Retrieves the details of an existing Account Type, including its configured field schemas. via GET /account-types/{account-type-id}

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

Retrieves the details of an existing Account. via GET /accounts/{account-id}

Gets relations for an Account by key via GET /accounts/{account-id}/relations

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

Retrieves the information for an existing API key. The plaintext value is only returned when creating or cloning an API key. via GET /api-keys/{api-key-id}

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

Retrieves the details of an existing API Log. via GET /api-logs/{api-log-id}

Retrieves the details of an existing Case Template, including its configured field schemas. via GET /case-templates/{case-template-id}

Returns a list of your organization's cases. Note that this endpoint aggregates cases across all case template(s). See [Pagination](https://docs.withpersona.com/pagination)for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. via GET /cases

Retrieves the details of an existing Case. via GET /cases/{case-id}

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. Results are returned in reverse chronological order, with the most recently created objects first. via GET /connect/connections

Retrieves the details of an existing Connection. via GET /connect/connections/{connection-id}

Returns a list of your organization's Share Tokens. Results are returned in reverse chronological order, with the most recently created objects first. via GET /connect/share-tokens

Retrieve the information for an existing Share Token. via GET /connect/share-tokens/{share-token-id}

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

Retrieves details of a specific Device. via GET /devices/{device-id}

Retrieves the details of a generic document that has been previously created. via GET /document/generics/{document-id}

Retrieves the details of a government-id document that has been previously created. via GET /document/government-ids/{document-id}

Retrieves the details of a Document. via GET /documents/{document-id}

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

Retrieves the details of an existing event. via GET /events/{event-id}

Retrieve a Graph Query via GET /graph-queries/{graph-query-id}

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

Retrieve the details of an existing importer. via GET /importers/{importer-id}

Returns a list of your organization's inquiries. Note that this endpoint aggregates inquiries across all inquiry template(s). See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. via GET /inquiries

Retrieves the details of an existing Inquiry. In the [Embedded Flow](https://docs.withpersona.com/embedded-flow), the `inquiry-id` is the first parameter of the onStart callback. In the [Hosted Flow](https://docs.withpersona.com/hosted-flow), the `inquiry-id` is a query parameter in the onComplete callback. Template information will be found in `data.relationships.inquiry-template` if the inquiry is a Dynamic Flow inquiry, and in `data.relationships.template` if the inquiry is a Legacy 2.0 inquiry. For more information, see [Dynamic Flow vs. Legacy Templates](https://docs.withpersona.com/inquiry-templates#dynamic-flow-vs-legacy-templates). via GET /inquiries/{inquiry-id}

Retrieves a list of Inquiry Sessions. Results are returned in reverse chronological order, with the most recently created objects first. via GET /inquiry-sessions

Retrieves details of a specific Inquiry Session. via GET /inquiry-sessions/{inquiry-session-id}

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. via GET /inquiry-template-versions

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. Results are returned in reverse chronological order, with the most recently created objects first. via GET /inquiry-templates

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. via GET /inquiry-templates/{inquiry-template-id}

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. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. via GET /inquiry-templates/{inquiry-template-id}/translations

Retrieves the details of an existing browser fingerprint List Item. via GET /list-item/browser-fingerprints/{list-item-id}

Retrieves the details of an existing country List Item. via GET /list-item/countries/{list-item-id}

Retrieves the details of an existing device fingerprint List Item. via GET /list-item/device-fingerprints/{list-item-id}

Retrieves the details of an existing email address List Item. via GET /list-item/email-addresses/{list-item-id}

Retrieves the details of an existing field List Item. via GET /list-item/fields/{list-item-id}

Retrieves the details of an existing geolocation List Item. via GET /list-item/geolocations/{list-item-id}

Retrieves the details of an existing government ID number List Item. via GET /list-item/government-id-numbers/{list-item-id}

Retrieves the details of an existing IP address List Item. via GET /list-item/ip-addresses/{list-item-id}

Retrieves the details of an existing name List Item. via GET /list-item/names/{list-item-id}

Retrieves the details of an existing phone number List Item. via GET /list-item/phone-numbers/{list-item-id}

Retrieves the details of an existing string List Item. via GET /list-item/strings/{list-item-id}

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

Retrieves the details of an existing list. via GET /lists/{list-id}

Returns a list of your current rate limits. via GET /rate-limits

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

Retrieves the details of an existing Report. via GET /reports/{report-id}

Retrieves the history of an existing Report, including runs and actions. See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. via GET /reports/{report-id}/history

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

Retrieves the details of an existing theme set. via GET /theme-sets/{theme-set-id}

Retrieves the details of an existing Transaction Type. via GET /transaction-types/{transaction-type-id}

Returns a list of your organization's transactions. Note that this endpoint aggregates transactions across all transaction type(s). See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. via GET /transactions

Retrieves the details of an existing Transaction. via GET /transactions/{transaction-id}

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. Results are returned in reverse chronological order, with the most recently created objects first. via GET /user-audit-logs

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. via GET /user-audit-logs/{user-audit-log-id}

Retrieve an AAMVA verification via GET /verification/aamvas/{verification-id}

Retrieve a database business verification via GET /verification/database-businesses/{verification-id}

Retrieve an eCBSV database verification via GET /verification/database-ecbsvs/{verification-id}

Retrieve a phone carrier database verification via GET /verification/database-phone-carriers/{verification-id}

Retrieve a Serpro database verification via GET /verification/database-serpros/{verification-id}

Retrieve a database standard verification via GET /verification/database-standards/{verification-id}

Retrieve a TIN database verification via GET /verification/database-tins/{verification-id}

Retrieve a database verification via GET /verification/databases/{verification-id}

Retrieves the details of a specific document verification via GET /verification/documents/{verification-id}

Retrieve a email address verification via GET /verification/email-addresses/{verification-id}

Retrieve a Government ID NFC verification via GET /verification/government-id-nfcs/{verification-id}

Retrieve a government ID verification via GET /verification/government-ids/{verification-id}

Retrieve a phone number verification via GET /verification/phone-numbers/{verification-id}

Retrieve a selfie ID verification via GET /verification/selfies/{verification-id}

Retrieves the details of an existing Verification. via GET /verifications/{verification-id}

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

Retrieves the details of an existing webhook, including its secret. via GET /webhooks/{webhook-id}

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

Retrieves the details of an existing workflow run. via GET /workflow-runs/{workflow-run-id}

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. The `live`, `rollout-label`, and `rollout-percentage` attributes are relative to the environment your API key belongs to: a version live in Production is not live in Sandbox. Sandbox API keys are supported, and report `live: false` for every version of a Workflow that is only deployed to Production. via GET /workflow-versions

Updates an existing Account. via PATCH /accounts/{account-id}

Updates an existing API key. via PATCH /api-keys/{api-key-id}

Updates the fields and add attachments on a Case that has been previously created. via PATCH /cases/{case-id}

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. Inquiries represent a snapshot of data collected from an individual, so we generally do not recommend updating an Inquiry's data after the Inquiry has been finalized. via PATCH /inquiries/{inquiry-id}

Sets simulated inputs on a Sandbox Inquiry. via PATCH /inquiries/{inquiry-id}/set-simulate-stubs

Updates an existing theme set. Both attributes are optional — an omitted attribute is left unchanged. When `styles` is present it replaces the stored styling wholesale: the tree carries the complete desired styling, and any cell absent from it falls back to the Persona default cascade. via PATCH /theme-sets/{theme-set-id}

Updates a Transaction that has been previously created. via PATCH /transactions/{transaction-id}

Updates an existing database business verification. Can only update `initiated` verifications. via PATCH /verification/database-businesses/{verification-id}

Updates an existing Webhook. via PATCH /webhooks/{webhook-id}

Creates a new Account for your organization. via POST /accounts

Adds a relation from an Account to a target Account or Transaction via POST /accounts/{account-id}/add-relation

Adds a new tag to an Account via POST /accounts/{account-id}/add-tag

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. After consolidation, you can update the destination Account's attributes using the [Account update endpoint](https://docs.withpersona.com/api-reference/accounts/update-an-account). This endpoint can be used to clean up duplicate Accounts. Note: A source account can only be consolidated once. Afterwards, the source account will be archived and unable to be used moving forward - any attempts to create an inquiry attached to the source account will fail. via POST /accounts/{account-id}/consolidate

Removes a relation from an Account to a target Account or Transaction. via POST /accounts/{account-id}/remove-relation

Removes an existing tag from an Account via POST /accounts/{account-id}/remove-tag

Triggers an account action for the specified account via POST /accounts/{account-id}/run-action

Sets all tags on an Account. Any tags that are not provided in the request will be removed. via POST /accounts/{account-id}/set-tags

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. Use the **Search** endpoint (`POST /accounts/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter by custom fields or identifiers, or apply multiple conditions simultaneously. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /accounts`) for simple listing with basic filters like reference ID. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating an account, use the List Accounts endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `type` | Account type (e.g., `acttp_ABC123`) | | `status` | Account status (e.g., `actst_ABC123`) | | `created_at` | Account creation timestamp | | `updated_at` | Account last updated timestamp | | `identifiers.*` | Custom identifier (e.g., `identifiers.user_id`) | | `fields.*` | Custom account field (e.g., `fields.age`) | **Note:** Custom fields (`fields.*`) must be configured as searchable on the Account Type to be queryable. via POST /accounts/search

Creates a new API key with response defaults and permissions. via POST /api-keys

Creates a copy of an existing API key. All attributes except the value are copied over to the new API key. via POST /api-keys/{api-key-id}/clone

Deactivates an API key within some time period via POST /api-keys/{api-key-id}/expire

Creates a new case in your organization. via POST /cases

Adds Persona objects (such as inquiries, accounts, or reports) to a Case via POST /cases/{case-id}/add-objects

Adds a new tag to a Case via POST /cases/{case-id}/add-tag

Assigns a Case to a Persona user. via POST /cases/{case-id}/assign

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. via POST /cases/{case-id}/remove-objects

Removes an existing tag from a Case via POST /cases/{case-id}/remove-tag

Sets the status of a Case. via POST /cases/{case-id}/set-status

Sets all tags on a Case. Any tags that are not provided in the request will be removed. via POST /cases/{case-id}/set-tags

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. Use the **Search** endpoint (`POST /cases/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter by custom fields, assignee, case queue, or SLA expiration, or apply multiple conditions simultaneously. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /cases`) for simple listing with basic filters like status, case template, account, inquiry, or report. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating a case, use the List Cases endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `template` | Case template (e.g., `ctmpl_ABC123`) | | `status` | Case status (e.g., `open`, `pending`, `resolved`) | | `state` | Case state | | `created_at` | Case creation timestamp | | `updated_at` | Case last updated timestamp | | `resolved_at` | Case resolution timestamp | | `sla_expires_at` | SLA expiration timestamp | | `assignee` | Assigned user (e.g., `user_ABC123`) | | `case_queue` | Case queue (e.g., `cqueue_ABC123`) | | `resolver` | Resolver user | | `fields.*` | Custom case field (e.g., `fields.priority`) | **Note:** Custom fields (`fields.*`) must be configured as searchable on the Case Template to be queryable. via POST /cases/search

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. Connections cannot be deleted, but they can be deactivated and later reactivated to control access. via POST /connect/connections

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. Connections that are already `inactive` cannot be deactivated again. via POST /connect/connections/{connection-id}/deactivate

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. Only inactive connections can be reactivated. via POST /connect/connections/{connection-id}/reactivate

Creates a new Share Token with the specified connection and source. Share Tokens can be created from Accounts, Inquiries, Transactions, or Verifications. via POST /connect/share-tokens

Expires a Share Token, setting its status to expired and preventing further use. via POST /connect/share-tokens/{share-token-id}/expire

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. - **Hydrate:** Provide `data.attributes.destination-id` to import source data into an existing object. Account, Transaction, and Inquiry Share Tokens can hydrate an existing Account, Transaction, or Inquiry. Redemption is asynchronous. A successful request returns the Share Token with a `pending` status while Persona processes the import. via POST /connect/share-tokens/{share-token-id}/redeem

Create a Graph Query via POST /graph-queries

Creates a new inquiry with optional pre-filled attributes. See [Sessions](https://docs.withpersona.com/inquiry-sessions) for how to continue the inquiry in [Embedded Flow](https://docs.withpersona.com/embedded-flow) or [Hosted Flow](https://docs.withpersona.com/hosted-flow). via POST /inquiries

Adds a new tag to an Inquiry. via POST /inquiries/{inquiry-id}/add-tag

Approves an Inquiry. Note that this action will trigger any associated workflows and webhooks. Approving an inquiry will prevent further progress on the inquiry. via POST /inquiries/{inquiry-id}/approve

Declines an Inquiry. Note that this action will trigger any associated workflows and webhooks. Declining an inquiry will prevent further progress on the inquiry. via POST /inquiries/{inquiry-id}/decline

Expires an Inquiry and all sessions on the Inquiry. Cancels any pending Verifications on the inquiry. The Inquiry can still be resumed after expiry. via POST /inquiries/{inquiry-id}/expire

Creates a new inquiry session and returns `meta.one-time-link`. via POST /inquiries/{inquiry-id}/generate-one-time-link

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. via POST /inquiries/{inquiry-id}/mark-for-review

Performs a series of simulated actions on a Sandbox Inquiry. via POST /inquiries/{inquiry-id}/perform-simulate-actions

Removes an existing tag from an Inquiry. via POST /inquiries/{inquiry-id}/remove-tag

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`. This endpoint will error if the inquiry is redacted. This endpoint first tries to reuse any existing valid unused [sessions](https://docs.withpersona.com/inquiry-sessions). If none exist, a new session is created. For more information, see [Resuming Inquiries](https://docs.withpersona.com/resuming-inquiries). via POST /inquiries/{inquiry-id}/resume

Sets all tags on an Inquiry. Any tags that are not provided in the request will be removed. via POST /inquiries/{inquiry-id}/set-tags

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. Use the **Search** endpoint (`POST /inquiries/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter on multiple statuses simultaneously, or apply multiple conditions at once. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /inquiries`) for simple listing with basic filters like reference ID. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating an inquiry, use the List Inquiries endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `status` | Inquiry status (e.g., `pending`, `completed`, `approved`, `declined`) | | `created_at` | Inquiry creation timestamp | | `updated_at` | Inquiry last updated timestamp | | `reference_id` | Reference ID associated with the inquiry's account | | `inquiry_template_id` | Inquiry template ID (e.g., `itmpl_ABC123`) | via POST /inquiries/search

Creates a new Inquiry Session. By default, we only allow up to 25 sessions per Inquiry. via POST /inquiry-sessions

Expires a specific Inquiry Session. via POST /inquiry-sessions/{inquiry-session-id}/expire

Generates a one-time link for a specific Inquiry Session. via POST /inquiry-sessions/{inquiry-session-id}/generate-one-time-link

Expires all active Inquiry Sessions for a given set of Inquiries. via POST /inquiry-sessions/expire-all

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. If no draft exists, a new draft is created from the latest published version before importing. The draft is never automatically published — publishing is always a manual step in the dashboard. 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. via POST /inquiry-templates/{inquiry-template-id}/translations

Create a new list for your organization. via POST /list/browser-fingerprints

Create a new list for your organization. via POST /list/countries

Create a new list for your organization. via POST /list/email-addresses

Create a new list for your organization. via POST /list/geolocations

Create a new list for your organization. via POST /list/government-id-numbers

Create a new list for your organization. via POST /list/ip-addresses

Create a new item in a list. via POST /list-item/browser-fingerprints

Create a new item in a list. via POST /list-item/countries

Create a new item in a list. via POST /list-item/device-fingerprints

Create a new item in a list. via POST /list-item/email-addresses

Create a new item in a list. via POST /list-item/fields

Create a new item in a list. via POST /list-item/geolocations

Create a new item in a list. via POST /list-item/government-id-numbers

Create a new item in a list. via POST /list-item/ip-addresses

Create a new item in a list. via POST /list-item/names

Create a new item in a list. via POST /list-item/phone-numbers

Create a new item in a list. via POST /list-item/strings

Create a new list for your organization. via POST /list/names

Create a new list for your organization. via POST /list/phone-numbers

Create a new list for your organization. via POST /list/strings

Authorizes another Organization to access your Inquiry, Verifications, or other Persona resources. via POST /oauth/authorize

Exchange a credential for an access token. Supports two grant types: - `authorization_code`: Exchange an authorization code for an access token (cross-org data sharing). - `client_credentials`: Exchange a signed JWT assertion (`private_key_jwt`) for a short-lived access token (machine-to-machine auth, RFC 7523). via POST /oauth/token

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). via POST /privacy-passes

Creates a new Relay. via POST /relays

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. via POST /relays/challenge

Creates a new Report of any type. via POST /reports

Adds a new tag to the Report via POST /reports/{report-id}/add-tag

Dismisses active matches for supported report types via POST /reports/{report-id}/dismiss

Pauses continuous monitoring on a report. Requires additional permissions. via POST /reports/{report-id}/pause

Removes an existing tag from a Report. via POST /reports/{report-id}/remove-tag

Resumes continuous monitoring on paused report. Requires additional permissions. via POST /reports/{report-id}/resume

Re-runs a continuously monitored report immediately, outside of its existing recurrence schedule. via POST /reports/{report-id}/run

Sets all tags on a Report. Any tags that are not provided in the request will be removed. via POST /reports/{report-id}/set-tags

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. via POST /theme-sets

Creates a new Transaction for a specific transaction type in your organization. via POST /transactions

Adds a relation between this Transaction and a target Account or Transaction using a relation schema key. No effect if the relation already exists. via POST /transactions/{transaction-id}/add-relation

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. via POST /transactions/{transaction-id}/add-tag

Create a new label for an existing Transaction. via POST /transactions/{transaction-id}/label

Permanently deletes biometric data for a Transaction AND all its associated objects. **This action cannot be undone**. via POST /transactions/{transaction-id}/redact-biometrics

Removes a relation between this Transaction and a target Account or Transaction. No effect if the relation does not exist. via POST /transactions/{transaction-id}/remove-relation

Remove a tag from a transaction. No effect if the transaction does not have the tag. via POST /transactions/{transaction-id}/remove-tag

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. via POST /transactions/{transaction-id}/set-tags

Create a new database business verification via POST /verification/database-businesses

Submit a database business verification for processing. Can only submit `initiated` verifications via POST /verification/database-businesses/{verification-id}/submit

Locks a Verification from redaction while it is under investigation. While locked, redaction requests for the Verification will be rejected. via POST /verifications/{verification-id}/investigation-lock

Unlocks a Verification that was previously locked from redaction during an investigation. via POST /verifications/{verification-id}/investigation-unlock

Search for webhook events using a flexible query language. Webhook events are the individual delivery records for your webhooks — one per event, per webhook. Use this endpoint to find events (for example, all `failed` deliveries for a given webhook in a time window) before re-running them. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation could be delayed during an outage. ## Retention Webhook events are retained for a limited window. Searches are automatically bounded to that window, so events older than the retention period are not returned even if requested. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `updated_at` | Timestamp the event was last updated (i.e. last delivery attempt). Supports `eq`, `gt`, `gte`, `lt`, `lte`. | | `status` | Delivery status: `pending`, `completed`, `failed`, or `skipped`. | | `webhook_id` | Webhook token (e.g. `wbh_ABC123`). | | `event_id` | Event token the webhook event was created from (e.g. `evt_ABC123`). | | `event_name` | Event name (e.g. `inquiry.completed`). | | `webhook_event_id` | Webhook event token (e.g. `wbhe_ABC123`). | | `related_object_ids` | A related object token contained in the event payload. | All attributes other than `updated_at` support only the `eq` operator. via POST /webhook-events/search

Creates a new webhook with response defaults. via POST /webhooks

Archives a webhook. via POST /webhooks/{webhook-id}/archive

Creates a copy of an existing webhook. All attributes except the secret are copied over to the new webhook. via POST /webhooks/{webhook-id}/clone

Disables a webhook. via POST /webhooks/{webhook-id}/disable

Enables a webhook. via POST /webhooks/{webhook-id}/enable

Rotates a webhook's secret. via POST /webhooks/{webhook-id}/rotate-secret

Creates a new Workflow Run. Note: The payload is arbitrary and defined by the Workflow version trigger schema. via POST /workflows/{workflow-id}/trigger