DocumentationAPI Reference
DocumentationAPI Reference

Types of 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 Set up > 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.

Event

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

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-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.

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

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 configuration.

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

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-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 configuration.

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

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

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

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

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

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

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.

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