API Documentation

Table of Contents

• Workflow & Rule Management

• Transaction Monitoring & Evaluation

Rule Management Service

List all workflows

Get Workflows

Get all workflows for a given tenant with optional status filtering.

Args: query_params: Query parameters including tenant_name and optional is_active flag service: Injected WorkflowService instance

Returns: List[Workflow]: List of workflows matching the criteria

Raises: HTTPException: For database errors or invalid input

get

/v1/risk/workflows

Authorizations

Query parameters

is_activeany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/risk/workflows'

200

422

200

[
  {
    "workflow_name": "text",
    "description": "text",
    "status": "ACTIVE",
    "deployments": [
      {
        "cluster_name": "text",
        "deployment_status": "PENDING",
        "last_synced_at": "2025-03-12T21:20:07.894Z"
      }
    ],
    "created_at": "2025-03-12T21:20:07.894Z",
    "updated_at": "2025-03-12T21:20:07.894Z"
  }
]

Successful Response

Create workflow

Create Workflow

Create a new workflow with initial rules.

post

/v1/risk/workflows

Authorizations

Body

workflow_namestringrequired

Name of the workflow

descriptionany of

Optional workflow description

initial_rulesobject[]required

Request model for creating a new rule

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/risk/workflows' \
  --header 'Content-Type: application/json' \
  --data '{
    "workflow_name": "text",
    "description": "text",
    "initial_rules": [
      {
        "rule_name": "text",
        "operator": "AND",
        "sub_rules": [
          {
            "field": "text",
            "operator": "<",
            "value": null,
            "storage_key": "text",
            "storage_field": "text"
          }
        ]
      }
    ]
  }'

200

422

200

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "rules": [
    {
      "rule_name": "text",
      "rule_definition": {},
      "stage": "REGISTERED",
      "status": "ACTIVE",
      "created_at": "2025-03-12T21:20:07.894Z",
      "updated_at": "2025-03-12T21:20:07.894Z"
    }
  ],
  "deployments": [
    {
      "cluster_name": "text",
      "deployment_status": "PENDING",
      "last_synced_at": "2025-03-12T21:20:07.894Z"
    }
  ],
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Get workflow by name

Get Workflow By Name

Get detailed workflow information by workflow name.

Args: workflow_name: Name of the workflow to retrieve service: Injected WorkflowService instance user_data: User context data including tenant information

Returns: WorkflowDetails: Detailed workflow information including rules and deployments

Raises: HTTPException: For database errors or if workflow is not found

get

/v1/risk/workflows/{workflow_name}

Authorizations

Path parameters

workflow_namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/risk/workflows/{workflow_name}'

200

422

200

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "rules": [
    {
      "rule_name": "text",
      "rule_definition": {},
      "stage": "REGISTERED",
      "status": "ACTIVE",
      "created_at": "2025-03-12T21:20:07.894Z",
      "updated_at": "2025-03-12T21:20:07.894Z"
    }
  ],
  "deployments": [
    {
      "cluster_name": "text",
      "deployment_status": "PENDING",
      "last_synced_at": "2025-03-12T21:20:07.894Z"
    }
  ],
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Update workflow status

Update Workflow Status

Update workflow status.

Args: workflow_name: Name of the workflow to update service: Injected WorkflowService instance user_data: User context data including tenant information

Returns: Workflow: Updated workflow information (without rules)

Raises: HTTPException: For validation or database errors

patch

/v1/risk/workflows/{workflow_name}/status

Authorizations

Path parameters

workflow_namestringrequired

Body

new_statusstring · enumrequired

New status to set for the workflow

Options: ACTIVE, INACTIVE, DEPRECATED

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/risk/workflows/{workflow_name}/status' \
  --header 'Content-Type: application/json' \
  --data '{
    "new_status": "ACTIVE"
  }'

200

422

200

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

List workflow rules

Get Workflow Rules

get

/v1/risk/workflows/{workflow_name}/rules

Authorizations

Path parameters

workflow_namestringrequired

Query parameters

stageany of

statusany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/risk/workflows/{workflow_name}/rules'

200

422

200

[
  {
    "rule_name": "text",
    "rule_definition": {},
    "stage": "REGISTERED",
    "status": "ACTIVE",
    "created_at": "2025-03-12T21:20:07.894Z",
    "updated_at": "2025-03-12T21:20:07.894Z"
  }
]

Successful Response

Create workflow rule

Create Workflow Rule

Create a new rule for a specific workflow.

post

/v1/risk/workflows/{workflow_name}/rules

Authorizations

Path parameters

workflow_namestringrequired

Body

operatorstring · enumrequired

Options: AND, OR

sub_rulesobject[]required

rule_namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/risk/workflows/{workflow_name}/rules' \
  --header 'Content-Type: application/json' \
  --data '{
    "operator": "AND",
    "sub_rules": [
      {
        "field": "text",
        "operator": "<",
        "value": null,
        "redis_key": "text",
        "redis_field": "text"
      }
    ],
    "rule_name": "text"
  }'

200

422

200

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Get workflow rule details

Get Workflow Rule

get

/v1/risk/workflows/{workflow_name}/rules/{rule_name}

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/risk/workflows/{workflow_name}/rules/{rule_name}'

200

422

200

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Update workflow rule

Update Workflow Rule

Update an existing rule in a workflow.

Args: rule_request: Rule update request data workflow_name: Name of the workflow rule_name: Name of the rule to update service: Injected RuleService instance user_data: User context data including tenant information

Returns: RiskRule: Updated rule data

Raises: HTTPException: For validation errors or if rule/workflow not found

put

/v1/risk/workflows/{workflow_name}/rules/{rule_name}

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

operatorstring · enumrequired

Options: AND, OR

sub_rulesobject[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/risk/workflows/{workflow_name}/rules/{rule_name}' \
  --header 'Content-Type: application/json' \
  --data '{
    "operator": "AND",
    "sub_rules": [
      {
        "field": "text",
        "operator": "<",
        "value": null,
        "redis_key": "text",
        "redis_field": "text"
      }
    ]
  }'

200

422

200

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Update rule status

Update Rule Status

Update rule status and sync to Redis if deployed.

patch

/v1/risk/workflows/{workflow_name}/rules/{rule_name}/status

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

new_statusstring · enumrequired

Options: ACTIVE, INACTIVE, DEPRECATED

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/risk/workflows/{workflow_name}/rules/{rule_name}/status' \
  --header 'Content-Type: application/json' \
  --data '{
    "new_status": "ACTIVE"
  }'

200

422

200

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

Update rule stage

Update Rule Stage

Update the stage of a specific rule.

Args: stage_update: Stage update request workflow_name: Name of the workflow rule_name: Name of the rule service: Injected RuleService instance user_data: User context data including tenant information

Returns: RiskRule: Updated rule data

patch

/v1/risk/workflows/{workflow_name}/rules/{rule_name}/stage

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

stagestring · enumrequired

Options: REGISTERED, BACKTESTING, STAGING, PRODEXPERIMENT, LIVE

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/risk/workflows/{workflow_name}/rules/{rule_name}/stage' \
  --header 'Content-Type: application/json' \
  --data '{
    "stage": "REGISTERED"
  }'

200

422

200

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-12T21:20:07.894Z",
  "updated_at": "2025-03-12T21:20:07.894Z"
}

Successful Response

---

Transaction Monitoring and Evaluation

Evaluate Risk

Evaluate risk for a transaction using specified workflow

post

/v1/risk/evaluate-risk

Body

workflow_idstringrequired

ID of the workflow to evaluate

transaction_idstringrequired

Unique identifier for the transaction

transaction_dataobjectrequired

Transaction data to be evaluated

evaluation_timestring · date-time

Timestamp when evaluation was requested

contextobject

Additional context for evaluation

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/risk/evaluate-risk' \
  --header 'Content-Type: application/json' \
  --data '{
    "workflow_id": "text",
    "transaction_id": "text",
    "transaction_data": {},
    "evaluation_time": "2025-03-12T21:20:07.894Z",
    "context": {}
  }'

200

422

200

{
  "transaction_id": "text",
  "workflow_id": "text",
  "evaluation_results": [
    {
      "rule_id": "text",
      "rule_name": "text",
      "result": "SUCCESS",
      "error_message": "text"
    }
  ],
  "evaluation_timestamp": "2025-03-12T21:20:07.894Z"
}

Successful Response