Get status and result of onboarding

get https://api.eu.mesh.complyadvantage.com/v2/workflows/{workflow_instance_identifier}

Overall workflow status

This endpoint will return the status and eventual end result of the specified workflow. Once a workflow has been initiated, it can be periodically polled to receive the status using the workflow-instance-identifier provided in the response of the POST v2/workflows/create-and-screen

The response comprises the status of the overall workflow. One of

NOT-STARTED - The workflow is queued but has not yet begun
IN-PROGRESS - The workflow is executing but not yet completed. The step details should be checked to ascertain progress
COMPLETED - The workflow has completed execution without errors. The step details should be checked to ascertain the end results
ERRORED - The workflow has completed with errors.

In addition to the status, the workflow endpoint returns:

steps - an array of the step keys within the workflow
step_details - an object containing the status and return values for each of steps within the workflow (see following section)

Workflow steps

The workflow response contains a step_details object, which contains the status and returned values from each step in the workflow. Each step object within the step_details contains a status field that can be one of the following values:

NOT-STARTED - The step has not yet been executed
IN-PROGRESS - The step is executing
COMPLETED - The step has completed and the step_output object can be checked for output
SKIPPED - The step has been skipped because it did not meet the criteria for execution. In the case of the “create and screen" workflow, this applies to the screening step when the customer risk is prohibited
ERRORED - The step has completed but returned errors

In addition to the status, the step detail contains:

identifier - a unique identifier for the step
step_output - an object containing the return values for the step