Skip to main content
POST
/
v1
/
risk
/
evaluate
Risk evaluate
curl --request POST \
  --url https://api.truthlocks.com/v1/risk/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "signal_type": "velocity",
  "subject_id": "<string>",
  "risk_score": 50,
  "subject_type": "user",
  "mint_receipt": true,
  "issuer_id": "<string>",
  "kid": "<string>"
}
'
{
  "decision_id": "<string>",
  "signal_id": "<string>",
  "decision": "allow",
  "policy_id": "<string>",
  "receipt_id": "<string>"
}

​
How Evaluation Works

  1. The signal is ingested into risk_signals
  2. Your active policy rules are evaluated (highest priority match wins)
  3. A risk_decision record is created with the outcome
  4. If mint_receipt: true and issuer_id/kid are provided, a fraud_decision_receipt is minted via the attestation service

​
Decision Outcomes

ActionMeaning
allowNo policy matched or score below all thresholds
challengeMFA or step-up authentication required
blockReject the action entirely
reviewRoute to manual fraud review queue

​
Built-in receipt types

Receipt TypePurpose
fraud_decision_receiptRecords allow/challenge/block/review decision
ato_alert_receiptRecords ATO alert events
risk_block_receiptProves an action was blocked
deepfake_detection_receiptRecords deepfake scan results

​
Request

​
signal_type
string
required
Signal type: velocity, ato, deepfake, impersonation, geo_anomaly, behavior, device_fingerprint
​
subject_id
string
required
Subject identifier.
​
risk_score
integer
required
Risk score (0–100).
​
subject_type
string
Defaults to user.
​
mint_receipt
boolean
If true, mints a fraud_decision_receipt after evaluation. Requires issuer_id and kid.
​
issuer_id
string
Issuer UUID for receipt minting.
​
kid
string
Key ID for receipt signing.

​
Response

​
decision
string
allow | challenge | block | review
​
decision_id
string
UUID of the risk decision record.
​
signal_id
string
UUID of the ingested risk signal.
​
policy_id
string
UUID of the matching policy rule (if any).
​
receipt_id
string
UUID of the minted receipt (only if mint_receipt: true and succeeded).

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
signal_type
enum<string>
required
Available options:
velocity,
ato,
deepfake,
impersonation,
geo_anomaly,
behavior,
device_fingerprint
​
subject_id
string
required
​
risk_score
integer
required
Required range: 0 <= x <= 100
​
subject_type
string
default:user
​
mint_receipt
boolean
​
issuer_id
string
​
kid
string

Response

Risk decision

​
decision_id
string
​
signal_id
string
​
decision
enum<string>
Available options:
allow,
challenge,
block,
review
​
policy_id
string | null
​
receipt_id
string | null