Checks and Documents related to a single screening workflow for a Customer.
Think of a Case as a folder for a particular compliance event, such as onboarding a new user, conducting a periodic review, or investigating a suspicious transaction. You create a case, attach checks to it (either at creation time or later), and all processing and results are tracked within its scope.
integer
required
A unique identifier for the case.
string
External ID for the case. Auto-generated UUID if not provided on creation. Stable across reruns. Must be unique per org among non-archived cases.
object
required
The customer object associated with this case.
string
An optional URL to receive notifications upon case completion.
string
Internal note about the case.
number
An overall risk score for the case, often aggregated from individual checks.
string
Email of the user assigned to this case. Must be a member of the organization. Set at creation time.
string
The final decision for the case, which can be
ACCEPTED, REJECTED, or PENDING.integer
Number of days until the case is automatically deleted. Use
0 for immediate deletion, or -1 for indefinite retention (never delete). Max 365. Defaults to -1 (indefinite).object
Case-specific metadata. Flexible JSON object.
array
External platform references for outbound sync. When configured, case updates (metadata, outcome, etc.) are automatically synced to the external platform (e.g. Salesforce). List of objects, e.g.
[{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}].array
A list of check objects associated with this case.