FIfireblocks
Compliance Orchestrator (Beta)

Trigger a Compliance Orchestrator screening

Starts a compliance screening against an active workflow and returns a screeningId. The screening runs asynchronously — poll GET /v1/compliance/orchestrator/screenings/{screeningId} for the result.

Unlike the screening that applies automatically to submitted transactions under /v1/screening, this is called on demand, before anything exists on-chain.

post/compliance/orchestrator/screenings

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

workflowIdstring required

The workflow to screen against. Must be in ACTIVE status.

Example request

{
  "workflowId": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
  "input": {
    "operation": "ADDRESS_SCREENING",
    "payload": [
      {
        "blockchain": "ETH",
        "asset": "ETH",
        "address": "0x9876543210fedcba9876543210fedcba98765432"
      }
    ]
  }
}

Response

Screening accepted

screeningIdstring required

Identifier of the screening that was created. Poll GET /v1/compliance/orchestrator/screenings/{screeningId} with it for the verdict.

screeningStatus'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

A screening's lifecycle status.

  • PENDING — accepted, not started
  • RUNNING — one or more steps in flight
  • COMPLETED — every step finished and the workflow outcome is set
  • FAILED — the screening could not be completed

Example response

{
  "screeningId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "screeningStatus": "COMPLETED"
}

Changes

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