Workflows API

The Workflows API allows you to execute pre-configured workflows for an individual entity, running consecutive checks on them through a single call, and retrieve an overall outcome that will determine whether they have passed.

Execute a workflow

To start onboarding an individual and running checks on them, you’ll need to call the "execute workflow" API endpoint. Upon execution, the workflow will return a result.

curl --location --request POST
'https://api.{{env}}.frankie.one/v2/individuals/{entityId}/serviceprofiles/kyc/workflows/{workflowName}/execute' \
--header 'api_key: {{your_apiKey}}' \
--header 'X-Frankie-CustomerID: {{your_CustomerID}}' \
--header 'X-Frankie-CustomerChildID: {{your_CustomerChildID}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \

Retrieve a workflow execution result

The workflow execution result can be retrieved at any time post execution by making a request to the GET /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId} API endpoint.

Retrieve a history of workflow execution result

The individual entity can be updated at any time by making a request to the PATCH /v2/individuals/{entityId} API endpoint.

For info on how to interpret workflow results, see Interpreting Workflow Results.