DocumentationAPI Reference
API ChangelogOpenAPIStatus

Events

Events are actions in the Persona system that you can use to trigger Webhooks and Workflows.

You can view events and their payloads in the Dashboard under Integration > Events. Events up to 3 months old can be viewed.

📘

Retrieve Events for your Organization programmatically through the Events API.

Types of Events

The following is a list of all the events that currently may be emitted by the Persona service.

This list can grow at any time so when developing against Persona events, please do not assume within your code that this is the full exhaustive list.

account.created data.object is an Account
Occurs whenever an account is created.

account.redacted data.object is an Account
Occurs whenever an account is redacted.

account.archived data.object is an Account
Occurs whenever an account is archived.

account.restored data.object is an Account
Occurs whenever an account is un-archived.

account.consolidated data.object is an Account
Occurs when the account was combined with another account.

account.tag-added data.object is an Account
Occurs when a tag was added to an account.

account.tag-removed data.object is an Account
Occurs when a tag was removed from an account.

account-property.redacted data.object is a Property
Occurs when an account property gets redacted.

case.created data.object is a Case
Occurs when a case is created.

case.assigned data.object is a Case
Occurs when a case is assigned.

case.resolved data.object is a Case
Occurs when a case is resolved.

case.reopened data.object is a Case
Occurs when a case is reopened.

case.updated data.object is a Case
Occurs when a case is updated.

document.created data.object is a Document
Occurs whenever a document is created.

document.submitted data.object is a Document
Occurs whenever a document is submitted.

document.processed data.object is a Document
Occurs whenever a document is processed.

document.errored data.object is a Document
Occurs whenever a document errors while processing.

inquiry.created data.object is an Inquiry
Occurs whenever an inquiry is created.

inquiry.started data.object is an Inquiry
Occurs whenever an inquiry is started. This happens the moment a verification is created or submitted on an inquiry.

inquiry.expired data.object is an Inquiry
Occurs when an inquiry expires. The default expiry is 24 hours.

inquiry.completed data.object is an Inquiry
Occurs whenever an inquiry completes all the configured verifications.

inquiry.failed data.object is an Inquiry
Occurs whenever an inquiry exceeds the configured number of verifications.

inquiry.marked-for-review data.object is an Inquiry
Occurs when an inquiry was marked for review either through Workflows or the API.

inquiry.approved data.object is an Inquiry
Occurs whenever an inquiry is approved manually in the dashboard or automatically through Workflows or the API.

inquiry.declined data.object is an Inquiry
Occurs when an inquiry is declined manually in the dashboard or automatically through Workflows or the API.

inquiry.transitioned data.object is an Inquiry
Occurs whenever a dynamic flow inquiry moves from one step in the inquiry flow to the next.

inquiry-session.started data.object is an Inquiry Session
Occurs whenever a user starts a session on an inquiry with a device. Multiple devices will each spawn a session.

inquiry-session.expired data.object is an Inquiry Session
Occurs when a session expires.

inquiry-session.canceled data.object is an Inquiry Session
Occurs when a session is manually canceled by the user. Because sessions may be resumed, there may be multiple cancel events for a given session.

report/address-lookup.ready data.object is a Report
Occurs when an address lookup report has completed processing.

report/address-lookup.errored data.object is a Report
Occurs when an address lookup report's processing has errored.

report/adverse-media.matched data.object is a Report
Occurs when an adverse media report has matched against at least one adverse media source as specified within the configuration.

report/adverse-media.ready data.object is a Report
Occurs when an adverse media report has completed processing.

report/adverse-media.errored data.object is a Report
Occurs when an adverse media report's processing has errored.

report/business-adverse-media.matched data.object is a Report
Occurs when a business adverse media report has matched against at least one adverse media source as specified within configuration.

report/business-adverse-media.ready data.object is a Report
Occurs when a business adverse media report has completed processing.

report/business-adverse-media.errored data.object is a Report
Occurs when a business adverse media report's processing has errored.

report/business-watchlist.ready data.object is a Report
Occurs when a business watchlist report has completed processing.

report/business-watchlist.matched data.object is a Report
Occurs when a business watchlist report has matched against a watchlist as specified within the configuration.

report/business-watchlist.errored data.object is a Report
Occurs when a business watchlist report's processing has errored.

report/email-address.ready data.object is a Report
Occurs when an email address report has completed processing.

report/email-address.errored data.object is a Report
Occurs when an email address report's processing has errored.

report/phone-number.ready data.object is a Report
Occurs when a phone number report is ready.

report/phone-number.errored data.object is a Report
Occurs when a phone number report's processing has errored.

report/profile.ready data.object is a Report
Occurs when a profile report is ready.

report/profile.errored data.object is a Report
Occurs when a profile report's processing has errored.

report/politically-exposed-person.matched data.object is a Report
Occurs when a politically exposed person (PEP) report has matched against a watchlist as specified within the configuration.

report/politically-exposed-person.ready data.object is a Report
Occurs when a politically exposed person (PEP) report has completed processing.

report/politically-exposed-person.errored data.object is a Report
Occurs when a politically exposed person (PEP) report's processing has errored.

report/watchlist.matched data.object is a Report
Occurs when a watchlist report has matched against a watchlist as specified within the configuration.

report/watchlist.ready data.object is a Report
Occurs when a watchlist report has completed processing.

report/watchlist.errored data.object is a Report
Occurs when a watchlist report's processing has errored.

selfie.created data.object is a Selfie
Occurs whenever a selfie is created.

selfie.submitted data.object is a Selfie
Occurs whenever a selfie is submitted.

selfie.processed data.object is a Selfie
Occurs whenever a selfie is processed.

selfie.errored data.object is a Selfie
Occurs whenever a selfie's processing has errored.

transaction.created data.object is a Transaction
Occurs whenever a transaction is created.

transaction.labeled data.object is a Transaction
Occurs whenever a transaction is labeled.

transaction.redacted data.object is a Transaction
Occurs whenever a transaction is redacted.

transaction.status-updated data.object is a Transaction
Occurs whenever a transaction's status is updated.

verification.created data.object is a Verification
Occurs whenever a verification is created.

verification.submitted data.object is a Verification
Occurs when a verification is submitted.

verification.passed data.object is a Verification
Occurs when a verification passes.

verification.failed data.object is a Verification
Occurs when a verification fails.

verification.requires-retry data.object is a Verification
Occurs when a verification requires the individual to retry.

verification.canceled data.object is a Verification
Occurs when a verification gets cancelled.