Skip to main content
GET
/
v2
/
workflows
Get a list of executable workflows
curl --request GET \
  --url https://api.uat.frankie.one/v2/workflows \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "workflows": [
    {
      "serviceName": "<string>",
      "workflowId": "<string>",
      "workflowName": "<string>",
      "workflowDisplayName": "<string>",
      "type": "<string>",
      "lifecyclePhase": "OTHER",
      "monitoringTypes": [
        "AML"
      ],
      "definition": {
        "definitionUpdatedAt": "2023-01-15T02:18:11.365Z",
        "version": "v1",
        "steps": [
          {
            "name": "Run KYC",
            "description": "Run the KYC step",
            "version": "1.0.0",
            "type": "BLOCKLIST",
            "configuration": {},
            "dependsOn": [
              "<string>"
            ]
          }
        ]
      }
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"[email protected]"

Query Parameters

​
serviceName
string[]

The unique name of the service profile (Supports multiple service names)

​
include
enum<string>[]

Query parameter to include additional fields of fetch workflow

Available options:
workflowDefinition

Response

OK

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
workflows
object[]

Provide a set of workflow lookup objects.