API Documentation

PreviousReal Time Transaction Monitoring NextRegistry

Last updated 1 month ago

Was this helpful?

Get Workflows

get

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

Authorizations

Query parameters

is_activeany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

[
  {
    "workflow_name": "text",
    "description": "text",
    "status": "ACTIVE",
    "deployments": [
      {
        "cluster_name": "text",
        "deployment_status": "PENDING",
        "last_synced_at": "2025-03-26T11:05:15.556Z"
      }
    ],
    "created_at": "2025-03-26T11:05:15.556Z",
    "updated_at": "2025-03-26T11:05:15.556Z"
  }
]

Successful Response

Get Workflow By Name

get

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

Authorizations

Path parameters

workflow_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "rules": [
    {
      "rule_name": "text",
      "rule_definition": {},
      "stage": "REGISTERED",
      "status": "ACTIVE",
      "created_at": "2025-03-26T11:05:15.556Z",
      "updated_at": "2025-03-26T11:05:15.556Z"
    }
  ],
  "deployments": [
    {
      "cluster_name": "text",
      "deployment_status": "PENDING",
      "last_synced_at": "2025-03-26T11:05:15.556Z"
    }
  ],
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Get Workflow Rules

get

Authorizations

Path parameters

workflow_namestringrequired

Query parameters

stageany ofoptional

statusany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

[
  {
    "rule_name": "text",
    "rule_definition": {},
    "stage": "REGISTERED",
    "status": "ACTIVE",
    "created_at": "2025-03-26T11:05:15.556Z",
    "updated_at": "2025-03-26T11:05:15.556Z"
  }
]

Successful Response

Get Workflow Rule

get

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Create Workflow

post

Create a new workflow with initial rules.

Authorizations

Body

workflow_namestringrequired

Name of the workflow

descriptionany ofoptional

Optional workflow description

initial_rulesobject[]required

Initial set of rules for the workflow

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "rules": [
    {
      "rule_name": "text",
      "rule_definition": {},
      "stage": "REGISTERED",
      "status": "ACTIVE",
      "created_at": "2025-03-26T11:05:15.556Z",
      "updated_at": "2025-03-26T11:05:15.556Z"
    }
  ],
  "deployments": [
    {
      "cluster_name": "text",
      "deployment_status": "PENDING",
      "last_synced_at": "2025-03-26T11:05:15.556Z"
    }
  ],
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Update Workflow Status

patch

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

Authorizations

Path parameters

workflow_namestringrequired

Body

new_statusstring · enumrequired

New status to set for the workflow

Options: ACTIVE, INACTIVE, DEPRECATED

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "workflow_name": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Create Workflow Rule

post

Create a new rule for a specific workflow.

Authorizations

Path parameters

workflow_namestringrequired

Body

operatorstring · enumrequired

Options: AND, OR

sub_rulesobject[]required

rule_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Update Workflow Rule

put

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

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

operatorstring · enumrequired

Options: AND, OR

sub_rulesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Update Rule Status

patch

Update rule status and sync to Redis if deployed.

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

new_statusstring · enumrequired

Options: ACTIVE, INACTIVE, DEPRECATED

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Update Rule Stage

patch

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

Authorizations

Path parameters

workflow_namestringrequired

rule_namestringrequired

Body

stagestring · enumrequired

Options: REGISTERED, BACKTESTING, STAGING, PRODEXPERIMENT, LIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "rule_name": "text",
  "rule_definition": {},
  "stage": "REGISTERED",
  "status": "ACTIVE",
  "created_at": "2025-03-26T11:05:15.556Z",
  "updated_at": "2025-03-26T11:05:15.556Z"
}

Successful Response

Evaluate Risk

post

Evaluate risk for a transaction using specified workflow

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-timeoptional

Timestamp when evaluation was requested

contextobjectoptional

Additional context for evaluation

Responses

application/json

cURL

JavaScript

Python

HTTP

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-26T11:05:15.556Z",
    "context": {}
  }'

200

422

{
  "transaction_id": "text",
  "workflow_id": "text",
  "evaluation_results": [
    {
      "rule_id": "text",
      "rule_name": "text",
      "result": "SUCCESS",
      "error_message": "text"
    }
  ],
  "evaluation_timestamp": "2025-03-26T11:05:15.556Z"
}

Successful Response

API Documentation

API Documentation

Table of Contents

Rule Management Service

List all workflows

Create workflow

Get workflow by name

Update workflow status

List workflow rules

Create workflow rule

Get workflow rule details

Update workflow rule

Update rule status

Update rule stage

Transaction Monitoring and Evaluation

Table of Contents

Rule Management Service

List all workflows

Create workflow

Get workflow by name

Update workflow status

List workflow rules

Create workflow rule

Get workflow rule details

Update workflow rule

Update rule status

Update rule stage

Transaction Monitoring and Evaluation

Get Workflows

Get Workflow By Name

Get Workflow Rules

Get Workflow Rule

Create Workflow

Update Workflow Status

Create Workflow Rule

Update Workflow Rule

Update Rule Status

Update Rule Stage

Evaluate Risk

Table of Contents

Rule Management Service

List all workflows

Create workflow

Get workflow by name

Update workflow status

List workflow rules

Create workflow rule

Get workflow rule details

Update workflow rule

Update rule status

Update rule stage

Transaction Monitoring and Evaluation

Table of Contents

Rule Management Service

List all workflows

Create workflow

Get workflow by name

Update workflow status

List workflow rules

Create workflow rule

Get workflow rule details

Update workflow rule

Update rule status

Update rule stage

Transaction Monitoring and Evaluation

Get Workflows

Show child attributes

Show child attributes

Get Workflow By Name

Get Workflow Rules

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Get Workflow Rule

Create Workflow

Show child attributes

Show child attributes

Show child attributes

Update Workflow Status

Create Workflow Rule

Show child attributes

Update Workflow Rule

Show child attributes

Update Rule Status

Update Rule Stage

Evaluate Risk

Show Transaction Data

Show Context