FIfireblocks
Compliance Orchestrator (Beta)

Get a Compliance Orchestrator workflow

Returns a workflow's status and its steps in execution order. Read it to see what a given workflowId will screen, and which fields its rules may reference.

get/compliance/orchestrator/workflows/{workflowId}

Request

Path parameters

workflowIdstring required

The workflow's identifier.

Response

Workflow

workflowIdstring required

Unique identifier of the workflow.

templateIdstring nullable

The template this workflow was provisioned from, if any.

status'ACTIVE' | 'DRAFT' 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.
titlestring required

User-facing display name for the workflow.

descriptionstring nullable

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

createdAtstring required

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

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.