Skip to main content
POST
/
risk-matrices
Create Risk Matrix
curl --request POST \
  --url http://api.gu1.ai/risk-matrices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "category": "<string>",
  "status": "<string>",
  "scoringConfig": {},
  "triggers": [
    {}
  ],
  "tags": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Creates a new risk matrix with scoring configuration and optional triggers.

​
Request Body

​
name
string
required
Risk matrix name
​
description
string
Risk matrix description
​
category
string
default:"custom"
Category: aml, kyc, fraud, sanctions, transaction_monitoring, customer_risk, regulatory, custom
​
status
string
default:"draft"
Status: draft, active, shadow, inactive
​
scoringConfig
object
Scoring configuration with thresholds
​
triggers
array
Array of trigger configurations
​
tags
array
Array of tags for organization

​
Trigger Configuration

Each trigger can have: 
{
  "name": "High Risk Trigger",
  "description": "Create investigation when risk is high",
  "condition": {
    "field": "riskScore",
    "operator": "gte",
    "value": 80
  },
  "action": "create_investigation",
  "priority": "HIGH"
}

​
Example

curl -X POST http://api.gu1.ai/risk-matrices \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Transaction Monitoring Matrix",
    "description": "Monitor high-risk transactions",
    "category": "transaction_monitoring",
    "status": "active",
    "scoringConfig": {
      "minScore": 0,
      "maxScore": 100,
      "thresholds": {
        "low": 30,
        "medium": 60,
        "high": 80
      }
    },
    "triggers": [
      {
        "name": "Critical Risk Trigger",
        "description": "Auto-create investigation for critical risk",
        "condition": {
          "field": "riskScore",
          "operator": "gte",
          "value": 90
        },
        "action": "create_investigation",
        "priority": "CRITICAL"
      },
      {
        "name": "Medium Risk Alert",
        "description": "Create alert for medium risk",
        "condition": {
          "field": "riskScore",
          "operator": "between",
          "value": [60, 89]
        },
        "action": "create_alert",
        "priority": "MEDIUM"
      }
    ],
    "tags": ["transaction", "aml"]
  }'

​
Response

{
  "riskMatrix": {
    "id": "rm-new-123",
    "name": "Transaction Monitoring Matrix",
    "status": "active",
    "triggers": [/* ... */]
  },
  "usingDefaultStrategy": false
}

​
Trigger Actions

  • create_alert: Create an alert
  • create_investigation: Create an investigation
  • send_notification: Send notification to team
  • block_entity: Block entity from processing
  • request_approval: Request manual approval
  • escalate: Escalate to supervisor

​
See Also