FIfireblocks
Compliance Orchestrator (Beta)

Get a Compliance Orchestrator screening's result

Returns the result of a screening started by POST /v1/compliance/orchestrator/screenings, with a result per workflow step and an audit log. Safe to poll: a screening still in flight reports PENDING or RUNNING. Only screenings owned by the requesting tenant are returned.

get/compliance/orchestrator/screenings/{screeningId}

Request

Path parameters

screeningIdstring required

The screening's identifier, returned by POST /v1/compliance/orchestrator/screenings.

Response

Screening result

screeningIdstring required

Identifier of the screening being queried.

workflowIdstring required

Identifier of the workflow that produced this screening.

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
outcome'ACCEPT' | 'REJECT' nullable

An ACCEPT/REJECT decision — the workflow's own outcome, a step's outcome, or the result of evaluating a step's outcome rules. null on a workflow outcome that is not decided yet.

Example response

{
  "screeningId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "workflowId": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
  "screeningStatus": "COMPLETED",
  "outcome": "ACCEPT",
  "steps": [],
  "auditLog": []
}

Changes

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