Override the status of a specific workflow execution.

Override the result of a specific workflow execution by its id.

Path parameters

entityIdstringRequired
serviceNamestringRequired
workflowNamestringRequired
workflowExecutionIdstringRequired

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional
Username provided by API caller

Request

This endpoint expects an object.
statusenumOptionalDefaults to UNCHECKED

Outcome of this workflow execution. Possible results:

  • UNCHECKED: The workflow has not yet been run and has no result.
  • IN_PROGRESS: The workflow is currently running and awaiting completion.
  • REVIEW: The workflow produced results that require review. Check the risks and step results for more details.
  • PASS: The workflow successfully completed with a PASS recommendation.
  • FAIL: The workflow finished with a FAIL recommendation.
  • COMPLETE: The workflow has finished and the results are considered complete. PASS/FAIL is not required.
  • INCOMPLETE: The workflow has finished and the results are considered incomplete. PASS/FAIL is not required.
  • NEEDS_APPROVAL: The workflow requires an approval process. Once approved, re-run the workflow.
  • APPROVED: The workflow was approved, typically by an external source such as a human.
  • REJECTED: The workflow was rejected, typically by an external source such as a human.
  • BLOCKED: The workflow was blocked from completing. Manual review is required.
  • CLEAR: The workflow completed with no issues raised. Often used for ongoing monitoring workflows.
  • URGENT: The workflow completed with matters requiring urgent review. Often used for ongoing monitoring workflows that return sanctions or similarly critical items.
  • MONITOR: The workflow completed and further monitoring is required. Should be manually reviewed.
commentobjectOptional

Response

Status has been updated
requestIdstring or null
The unique request identifier for the API call made.
workflowResultobject or null

Errors