Skip to main content
A Case is the central hub for a specific investigation. It acts as a container that groups together all the 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.
​
id
integer
required
A unique identifier for the case.
​
external_id
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.
​
customer
object
required
The customer object associated with this case.
​
webhook_url
string
An optional URL to receive notifications upon case completion.
​
note
string
Internal note about the case.
​
risk_score
number
An overall risk score for the case, often aggregated from individual checks.
​
assignee
string
Email of the user assigned to this case. Must be a member of the organization. Set at creation time.
​
outcome
string
The final decision for the case, which can be ACCEPTED, REJECTED, or PENDING.
​
delete_after
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).
​
metadata
object
Case-specific metadata. Flexible JSON object.
​
sync_platforms
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..."}].
​
checks
array
A list of check objects associated with this case.