Case Status Model

Each case has two different types of status:

1. Run Status – Workflow Execution

Tracks where the case is in the execution pipeline:

Run StatusDescription
NOT_STARTEDWorkflow not yet initiated
SUBMITTEDUser submitted details in UI
RUNNINGWorkflow executing
PENDINGWaiting for external data or input
COMPLETEDExecution finished
FAILEDWorkflow error

2. Result Status – Verification Outcome

Represents the final decision:

Result StatusMeaning
APPROVEDVerification passed
DECLINEDVerification failed
REVIEWNeeds manual review
UNKNOWNNo decision yet

Typical Combinations

  • RUNNING + UNKNOWN → In progress
  • COMPLETED + APPROVED → Verification successful
  • COMPLETED + DECLINED → Verification failed
  • COMPLETED + REVIEW → Requires manual review
  • FAILED + UNKNOWN → Workflow error

Case Metadata

Every case stores structured metadata that helps track and correlate verification attempts.

FieldDescription
verification_session_idUnique case/session ID
entity_typeUSER or BUSINESS
template_idTemplate used for verification
client_reference_idYour internal reference ID
client_reference_dataCustom metadata (JSON)
callback_urlURL for verification result delivery
events_callback_urlURL for real-time event notifications
created_atCase creation timestamp
processing_start_timeWhen workflow started
processing_end_timeWhen workflow finished
expires_atSession expiration time (for hosted UI links)

Client References

Client references allow you to map AiPrise cases to your internal systems.

Example Usage

{
  "template_id": "template-uuid",
  "client_reference_id": "order-12345",
  "client_reference_data": {
    "order_id": "order-12345",
    "customer_tier": "premium",
    "source": "mobile_app"
  },
  "user_data": { ... }
}

Benefits:

  • Correlation: Link verification to orders, users, workflows
  • Analytics: Segment checks by region, tier, product, etc.
  • Debugging: Easily search and track verifications

The same metadata is returned in API responses and webhook callbacks.