[DEPRECATED] Cases

❗️
Deprecated
This content has been deprecated as this feature has been discontinued. If you have any questions, please contact [email protected].

A case is created for a Decision that requires manual review. A Case will have a status of opened when it is created and resolved when it has been reviewed. The associated Decision will be either denied or approved.

Related Guides: Onboarding Users, Transaction Monitoring.

Attribute	Description
id string	Unique identifier for the Case.
status string	The current status of the Case. One of `open` or `resolved`. The decision on the case is captured in the associated `Decision`.
caseable_type string	The type of associated object for the Case. Currently, it will be `Decision`.
caseable_id string	The ID of the associated object for the Case. Currently, it will be the ID of the `Decision`.
reason string	This is an optional field that will have a value when the case is resolved. Currently, it will be one of the values: `resolved_by_reviewers`, `tin_retried`, and `decision_cancelled`.
live_mode boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
metadata jsonb	Additional data represented as key-value pairs. Both the key and value must be strings.

{
  "id": "1cc80021-344c-4989-8f7b-8543b55b1ed0",
  "object": "case",
  "live_mode": true,
  "metadata": {},
  "caseable_type": "decision",
  "caseable_id": "ac5389f1-9f11-4c78-bd4f-2f17a055d567",
  "status": "opened",
  "reason": nil,
  "created_at": "2022-05-16T05:18:19Z",
  "updated_at": "2022-05-16T05:18:19Z"
}