[DEPRECATED] Decisions

❗️

Deprecated

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

A decision represents a User Onboarding, Payment Order, or Incoming Payment Detail being evaluated for risk. Each Decision is scored one of low, medium, high, and very_high. By default, a Decision with a score of low or medium is automatically approved and a Decision with a score of very high is automatically denied; a Decision with a score of high will have a Case opened for manual review.

Related Guides: Onboarding Users, Transaction Monitoring.

AttributeDescription
id
string
Unique identifier for the Decision.
status
string
The current status of the Decision. One of pending, needs_approval, approved, denied.
score
string
One of low, medium, high, very_high.
decision_type
string
One of user_onboarding, transaction_monitoring, incoming_payment_detail.
decisionable_id
string
The ID of the object being scored.
decisionable_type
string
The type of the object being scored. One of user_onboarding or payment_order.
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": "361739d5-b0e2-46ce-bd8c-3973960769b7",
  "object": "compliance_decision",
  "live_mode": true,
  "metadata": {},
  "score": "medium",
  "decision_type": "user_onboarding",
  "created_at": "2022-05-07T00:11:07Z",
  "updated_at": "2022-05-07T00:12:15Z",
  "status": "needs_approval",
  "decisionable_type": "user_onboarding",
  "decisionable_id": "ff2c9883-fe0a-4201-b0d2-9772383daa67",
  "verifications": [
    {
      "id": "b209f8ba-cce7-47e8-a250-e4c396c8d155",
      "live_mode": true,
      "metadata": {},
      "status": "completed",
      "verification_type": "comprehensive_kyc",
      "result": {
        "sessionKey": "ff2c9883-fe0a-4201-b0d2-9772383daa67",
        "level": "medium",
        "status": "Success",
        "customer": {
          "score": 26,
          "level": "medium",
          "signals": [
            {
              "key": "adverseMediaLevel",
              "value": "low"
            },
            {
              "key": "bankLevel",
              "value": "low"
            },
            {
              "key": "emailDomainLevel",
              "value": "low"
            },
            {
              "key": "emailLevel",
              "value": "medium"
            },
            {
              "key": "nsfLevel",
              "value": "low"
            },
            {
              "key": "pepLevel",
              "value": "low"
            },
            {
              "key": "phoneLevel",
              "value": "low"
            },
            {
              "key": "sanctionLevel",
              "value": "low"
            }
          ]
        },
        "checkpoints": {
          "customer": {
            "customerPurchaseLevel": {
              "value": "low",
              "ruleIds": [
                120,
                124
              ]
            },
            "emailLevel": {
              "value": "medium",
              "ruleIds": [
                3
              ]
            },
            "historicalLevel": {
              "value": "low",
              "ruleIds": [
                118,
                124
              ]
            },
            "riskLevel": {
              "value": "medium",
              "ruleIds": [
                3
              ]
            }
          }
        }
      }
    }
  ]
}