# API Documentation

## Table of Contents

* [**Workflow & Rule Management**](#rule-management-service)
* [**Transaction Monitoring & Evaluation**](#transaction-monitoring-and-evaluation)

## Rule Management Service

#### List all workflows

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows" method="get" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Create workflow

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows" method="post" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Get workflow by name

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}" method="get" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Update workflow status

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/status" method="patch" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### List workflow rules

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules" method="get" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Create workflow rule

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules" method="post" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Get workflow rule details

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules/{rule\_name}" method="get" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Update workflow rule

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules/{rule\_name}" method="put" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Update rule status

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules/{rule\_name}/status" method="patch" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

#### Update rule stage

{% openapi src="/files/3qZhFtv1pGxTSAPQ4CBv" path="/v1/risk/workflows/{workflow\_name}/rules/{rule\_name}/stage" method="patch" expanded="true" %}
[workflows.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media)
{% endopenapi %}

***

## Transaction Monitoring and Evaluation

{% openapi src="/files/lWOYQJ4tiuQMBqhRygQR" path="/v1/risk/evaluate-risk" method="post" expanded="true" %}
[txn-eval.json](https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-4c9a43e4768ebf8d4eb6bcc282abde0dc7d2550f%2Ftxn-eval.json?alt=media)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.canso.ai/risk/openapi_3_1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.