For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsAPI ReferenceChangelog
OverviewInquiriesTransactionsAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Response Body
    • Idempotence
    • Pagination
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • OpenAPI Specification
    • Cases
      • GETList all Cases
      • POSTCreate a Case
      • GETRetrieve a Case
      • DELRedact a Case
      • PATCHUpdate a Case
      • POSTAdd Persona objects to a Case
      • POSTAssign a Case
      • POSTSet status on a Case
      • POSTAdd tag to a Case
      • POSTRemove tag from a Case
      • POSTSet tags on a Case
      • POSTSearch Cases
    • Connect
    • Documents
    • Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API Reference

Cases

A case in Persona represents a collection of data about an end-user that needs to be investigated and decisioned on. The case includes related objects such as inquiry(s), account(s), and report(s).

A case can have one of a few statuses representing where it is in its lifecycle. These statuses can be completely customized depending on your organization’s preferred investigation process. For more information about how to customize the statuses for a given Case, refer to our help center post. When you create a status, it will be categorized as one of the following:

Status TypeDescription
initialThe case is ready for investigation. There can only be one initial status for a given case template. When cases are created, they will have this status.
intermediateThe case is currently undergoing investigation. It is possible to customize the intermediate statuses to model different stages of your investigation process.
endThe investigation is complete. End statuses can be added and named to model the decisions that result from your investigation (e.g. Accept, Decline, etc.)
Was this page helpful?
Previous

List all Cases

Next
Built with