DocumentationAPI Reference
DocumentationAPI Reference

Getting started

Workflows are a powerful tool for administering your identity needs both within Persona and your own systems, and can operate on data in either system alike.

Using a simple and intuitive editor, you can automate manual processes such as automatically tagging high-risk Inquiries, running additional Reports when specific conditions get met, and ingesting non Persona 3rd party data. Workflows are highly configurable and scalable. They drastically simplify how you manage customer identity.

Trigger a Workflow

All Workflows begin with a trigger, which initiates the Workflow. Three trigger types exist:

  1. Event triggers: Configure your Workflow to initiate when one of the following events in Persona occurs:

    Case event triggers:

    • case.created
    • case.resolved
    • case.reopened

    Inquiry event triggers:

    • inquiry.created
    • inquiry.approved
    • inquiry.completed
    • inquiry.declined
    • inquiry.expired
    • inquiry.failed
    • inquiry.marked-for-review

    Report event triggers:

    • report/adverse-media.matched
    • report/adverse-media.ready
    • report/address-lookup.ready
    • report/background-check.ready
    • report/business-adverse-media.ready
    • report/business-lookup.ready
    • report/business-watchlist.ready
    • report/email-address.ready
    • report/phone-number.ready
    • report/politically-exposed-person.matched
    • report/politically-exposed-person.ready
    • report/profile.ready
    • report/social-media.ready
    • report/synthetic.ready
    • report/watchlist.matched
    • report/watchlist.ready
  2. API Triggers: Initiate a Workflow via an API request to Persona. Pass in any data in the body of the request which the Workflow can then access.

  3. Scheduled Triggers: Run a workflow at a regular cadence.

Take Action

Workflows support a large library of actions that assist with your automation and orchestration needs.

  • Add Item to List: Populate Persona Lists.
  • Approve Inquiry: Approve Persona Inquiries.
  • Create Case: Create a Persona Case for manual review.
  • Create Inquiry: Create a Persona Inquiry.
  • Decline Inquiry: Decline Persona Inquiries.
  • Evaluate Code: Craft custom JS logic.
  • Inquiry Link Email: Send emails containing Inquiry links.
  • Inquiry Link SMS: Send SMS containing Inquiry links.
  • Make HTTPS Request: POST and GET to HTTPS endpoints. Configure template-level Webhooks as well.
  • Mark Inquiry for Review: Mark Persona Inquiries for Review.
  • Run Report: Access and run the full library of Reports. Examples include Person Watchlist and Adverse Media Report, among others.
  • Run Workflow: Initiate another Persona Workflows. Useful to chain together multiple Workflows.
  • Send Email: Fully customize email messages sent via Persona. Includes HTML styling, as well as advanced configuration options to specify the From email address, SMTP server address, SMTP server port, SMTP server TLS, SMTP server user, and SMTP server password.
  • Send Slack Message: Send Slack messages.
  • Send SMS: Fully customize SMS messages sent via Persona.
  • Tag Object: Tag Persona objects (e.g. Inquiries, Cases, Reports, etc).
  • Update Salesforce: Update Salesforce objects.
  • Update Zendesk: Update Zendesk tickets.

Asynchronous Activity

Workflows support asynchronous activity by allowing users to listen for events in the Persona ecosystem and then action on those events when they happen.

Workflows currently support three types of Wait steps:

  1. Wait on Objects: Configure your Workflow to wait on one or many events. As an example, you can set up a Workflow to wait for an Inquiry to get approved, a Case to get created, etc.
  2. Default Resolution: Paired with Wait on Objects. Default Resolution allows you to specify a timeout after which the Workflow can proceed if the event the Workflow listens for never occurs.
  3. Wait for Time: You can also configure your Workflow to Wait for a specified period of time to pass.

Conditional and Parallel Logic

Workflows can condition off numerous criteria, including:

  • 3rd party criteria (e.g. values returned by custom code functions, ingested via API triggers, etc)
  • Inquiry criteria (e.g. age, country, government ID number, selfie liveness score, etc)
  • Report criteria (e.g. watchlist match, adverse media match, results from synthetic fraud report runs, etc)
  • Case criteria (e.g. status of case resolutions, etc)
  • Account criteria (e.g. tags associated with count, etc)
  • Template criteria (e.g. certain inquiry templates, etc)
  • Database criteria (e.g. matches found against databases Persona supports, etc)

With API triggered Workflows, users can configure the input schema and the Workflow conditionals can then access those defined fields in subsequent steps.

Workflows also supports parallel logic. As an example, with a parallel step, you can run two Reports at the same time.