Skip to main content
POST
/
api
/
v1
/
assess
Assess transaction risk
curl --request POST \
  --url https://sandbox.clausum.ai/api/v1/assess \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1500,
  "currency": "MXN",
  "transaction_type": "payment",
  "email": "customer@example.com",
  "customer_id": "cus_abc123",
  "payment_method": {
    "type": "card",
    "card_bin": "411111",
    "card_last4": "4242",
    "card_country": "MX",
    "card_brand": "visa"
  },
  "device": {
    "fingerprint": "fp_9a8b7c6d",
    "ip": "201.150.10.22",
    "user_agent": "Mozilla/5.0"
  },
  "billing": {
    "country": "MX",
    "city": "CDMX",
    "postal_code": "06600"
  },
  "metadata": {
    "order_id": "ORD-123"
  }
}
'
{
  "decision": "approve",
  "risk_score": 8,
  "signals": [
    "short_session"
  ],
  "signal_details": [
    {
      "code": "short_session",
      "weight": 8,
      "description": "Session under 5s"
    }
  ],
  "session_id": "ps_1716998400000_a1b2c3d4e",
  "blocked_by": null,
  "latency_ms": 42
}

Authorizations

​
Authorization
string
header
default:clm_sk_your_secret_key
required

Secret API key, e.g. clm_sk_.... Pass it as Authorization: Bearer clm_sk_....

Body

application/json
​
amount
number
required

Transaction amount in the smallest currency unit (e.g. cents).

Required range: x >= 0
​
currency
string
required
Example:

"MXN"

​
session_id
string

Reuse a session id returned by the browser SDK to merge behavioral signals.

​
transaction_type
string

payment, transfer, withdrawal, etc.

Example:

"payment"

​
email
string<email>
​
phone
string
​
customer_id
string

Your internal customer identifier.

​
customer_name
string
​
payment_method
object
​
device
object
​
behavior
object
​
shipping
object
​
billing
object
​
metadata
object

Response

Assessment completed

​
decision
enum<string>
Available options:
approve,
review,
challenge,
decline
​
risk_score
integer
Required range: 0 <= x <= 100
​
signals
string[]

Codes of the signals that fired.

​
signal_details
object[]
​
session_id
string
​
blocked_by
string | null

Reason when the transaction was hard-blocked.

​
latency_ms
integer