Get a Compliance Orchestrator workflow

GET

compliance

orchestrator

workflows

{workflowId}

TypeScript

const response: Promise<FireblocksResponse<GetWorkflowResponse>> = fireblocks.complianceOrchestratorBeta.getWorkflow(complianceOrchestratorBetaApiGetWorkflowRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "workflowId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "ACTIVE",
  "title": "KYT Screening - EU Customers",
  "createdAt": "1735689600",
  "steps": [
    {
      "stepId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "connectorId": "kyt_trmlabs",
      "operations": [],
      "order": 0
    }
  ],
  "templateId": "m1-kyt-workflow",
  "description": "Screens EU customer addresses against KYT risk providers."
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

workflowId

string

required

The workflow's identifier.

Response

Workflow

A workflow's current definition, including its steps and each step's rule sets.

A workflow is the configuration a screening runs against: an ordered list of steps, each backed by one connector. It must be ACTIVE before a screening will accept it — DRAFT is the editing state, so a screening never runs against a half-finished configuration.

workflowId

string

required

Unique identifier of the workflow.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

status

enum<string>

required

A workflow's status, which controls whether it can be screened against.

DRAFT — the editing state. Rules can be changed while nothing is screening against them, so a screening never runs against a half-finished configuration.
ACTIVE — POST /v1/compliance/orchestrator/screenings accepts screenings against this workflow.

Available options:

ACTIVE,

DRAFT

Example:

"ACTIVE"

title

string

required

User-facing display name for the workflow.

Example:

"KYT Screening - EU Customers"

createdAt

string

required

Unix timestamp in seconds when the workflow was provisioned, encoded as a string.

Example:

"1735689600"

steps

object[]

required

Flat list — one step per connector.

Show child attributes

Example:

[
  {
    "stepId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "connectorId": "kyt_trmlabs",
    "operations": [],
    "order": 0
  }
]

templateId

string | null

The template this workflow was provisioned from, if any.

Example:

"m1-kyt-workflow"

description

string | null

User-facing free-text description of the workflow's purpose.

Example:

"Screens EU customer addresses against KYT risk providers."

⌘I

TypeScript

const response: Promise<FireblocksResponse<GetWorkflowResponse>> = fireblocks.complianceOrchestratorBeta.getWorkflow(complianceOrchestratorBetaApiGetWorkflowRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "workflowId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "ACTIVE",
  "title": "KYT Screening - EU Customers",
  "createdAt": "1735689600",
  "steps": [
    {
      "stepId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "connectorId": "kyt_trmlabs",
      "operations": [],
      "order": 0
    }
  ],
  "templateId": "m1-kyt-workflow",
  "description": "Screens EU customer addresses against KYT risk providers."
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Path Parameters

Response