Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

1

Integration overview

Check out the integration page for an overview of the implementation process.
2

Workflow configured for transaction and activity monitoring

Before you can start verifying customers, your account needs to be configured with at least one workflow and one service profile. Your Customer Success Manager typically sets these up for you.You can confirm your setup by calling the GET /v2/workflows endpoint. This will list all the executable monitoring workflows available to you. For Transaction and Activity Monitoring, it is critical to have only one workflow with a lifecyclePhase: MONITORING and monitoringTypes: [“ACTIVITY”]

​
Request - Get workflows

curl --location '[https://api.uat.frankie.one/v2/workflows](https://api.uat.frankie.one/v2/workflows)' \--header 'api_key: {{your_api_key}}' \--header 'X-Frankie-CustomerId: {{your_customer_id}}'
You should receive a 200 OK response with a workflows array. If the array is empty, please contact your Customer Success Manager to get your workflows published.

​
Response - Get workflows

{
  "requestId": "req_01J...",
  "workflows": [
    {
      "serviceName"   : "DEFAULT",
      "workflowId"    : "wf_01J...",
      "workflowName"  : "Monitoring",
      "type"          : "SYSTEM",
      "lifecyclePhase": "MONITORING",
      "monitoringTypes": ["ACTIVITY"]
    }
  ]
}

​
Implementation steps

Once your prerequisites are complete, follow these steps in order.
1

Evaluate an activity

Send a transaction or event to FrankieOne for evaluation using the Evaluate an activity endpoint. This is where you structure your request payload and submit it to the API. Go to Evaluate an activity
2

Interpret activity results

Read the workflowResult response to understand the outcome, identify any alerts that were generated, and determine whether manual review is required. Go to Interpret activity results
3

Resolve alerts and re-evaluate

Update the status of any alerts via the API and trigger a workflow re-evaluation to close out the activity. Go to Resolve alerts and re-evaluate

​
Error handling

For a full list of error codes and response structures returned at any step, see Error handling.