KYC V2 APIIndividual Workflows

Override the status of a specific workflow execution.

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

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

serviceNamestringRequired

The unique name of the service profile

workflowNamestringRequired

The unique name of the workflow

workflowExecutionIdstringRequired

Unique workflow execution identifier

Headers

api_keystringRequired
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

Query parameters

levelenumOptionalDefaults to meta

Determines what level of detail to return in the response

  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and images as base64
Allowed values:

Request

This endpoint expects an object.
statusenumOptionalDefaults to UNCHECKED

Outcome of this workflow execution. Results can be one of:

  • UNCHECKED - The workflow has yet to be run and has no result.
  • IN_PROGRESS - The workflow is currently running and is awaiting completion
  • REVIEW - The outcome of the workflow has produced results that require review. Check the risks and step results for more.
  • PASS - The workflow successfully completed to produce a PASS recommendation
  • FAIL - The workflow finished with the recommendation being a FAIL
  • COMPLETE - The workflow has finished and the results are considered to be complete. A PASS/FAIL in this case is not required.
  • INCOMPLETE - The workflow has finished and the results are considered to be incomplete. A PASS/FAIL in this case is not required.
  • NEEDS_APPROVAL - The workflow has reached a point where an approval process needs to be run. Once done, you should re-run this workflow
  • APPROVED - The workflow has been run with the final outcome being approved, most likely by an external source, such as a human.
  • REJECTED - The workflow has been run with the final outcome being rejected, most likely by an external source, such as a human.
  • BLOCKED - The workflow has been blocked from completing. Manual review will be required.
  • CLEAR - The workflow has completed and there are no issues raised. Often used with ongoing monitoring workflows
  • URGENT - The workflow has completed are there are matters deemed to require urgent review. Often used with ongoing monitoring workflows that return sanctions or similarly critical items of interest.
  • MONITOR - The workflow has completed and it is determined that further monitoring is required. Should be manually reviewed.
commentobjectOptional

Response

Status has been updated

requestIdstringOptional

The unique request ID for the API call made.

workflowResultobjectOptional

Errors