# 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<https://4002575704-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcE4BqP2R5KBg2It3L34D%2Fuploads%2Fgit-blob-ddb15dd422a55dfdb95e80b5f44c859b3dfe21ba%2Fworkflows.json?alt=media>" 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="<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>" 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 %}