Skip to main content
POST
TypeScript

Headers

Idempotency-Key
string

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.

Body

application/json

Request to trigger a screening against an active workflow.

workflowId
string
required

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

Example:

"b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e"

input
object
required

What the caller wants screened, and how.

Response

Screening accepted

Acknowledgement that a screening was accepted and is now running.

screeningId
string
required

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

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

screeningStatus
enum<string>
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
Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED
Example:

"COMPLETED"