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.
Document Overview
What You’ll Learn:
- Available standard workflow bundles and their intended use cases
- Workflow IDs and naming conventions
- How workflows are configured and customised
- Differences between V2 workflows and V1 entity profiles (recipes)
Who Should Read This:
- Developers implementing FrankieOne
- Compliance teams selecting appropriate workflows
- Product managers planning verification requirements
Note: This guide covers V2 workflows (current standard). V1 references are included for context. See V1 Entity Profiles (Recipes) for legacy details.
Table of Contents
- Understanding Workflow Bundles
- Workflow ID Naming Convention
- Discovering Available Workflows
- Australian (AU) Workflows
- New Zealand (NZ) Workflows
- United States (US) Workflows
- United Kingdom (UK) Workflows
- Specialised Workflows
- Choosing the Right Workflow
- How Workflows Are Configured
- V1 Entity Profiles (Recipes)
- FAQs
Understanding Workflow Bundles
What is a Workflow Bundle?
A workflow bundle is a pre-configured verification workflow that combines multiple checks in a specific order to meet common compliance requirements. Workflow bundles are configured and managed by FrankieOne — they are not self-service editable via the API or Portal.
Bundle Categories
FrankieOne organises workflow bundles into two main categories:
Essential Bundles — Standard customer due diligence for low-to-medium risk scenarios.
- Foundational identity verification
- Standard AML screening (PEP & Sanctions)
- Electronic verification (KYC checks)
- Optional document verification
- Suitable for high-volume operations
Enhanced Bundles — For higher-risk environments requiring stronger identity assurance.
- Mandatory document verification (IDV)
- Biometric checks (liveness, face match)
- Enhanced AML screening (includes Adverse Media)
- Multiple data source verification
Workflow Components
Every workflow bundle contains a combination of these check types:
| Check Type | Description | Essential | Enhanced |
|---|
| Blocklist | Checks against your internal blocklist | ✓ | ✓ |
| KYC | Verifies identity details against data sources | ✓ | ✓ |
| Government ID | Verifies government-issued ID number | Optional | ✓ |
| IDV | Validates document authenticity & biometrics | Optional | Mandatory |
| AML (Standard) | Screens PEP & Sanctions lists | ✓ | — |
| AML (Enhanced) | Screens PEP, Sanctions & Adverse Media | — | ✓ |
| Risk Assessment | Calculates overall risk score | ✓ | ✓ |
Note: The specific checks, data sources, and routing within a workflow are configured by FrankieOne. These are not dynamically controlled via the API. Contact your FrankieOne representative to discuss workflow composition.
Workflow ID Naming Convention
All standard workflow IDs follow a consistent structure:
{COUNTRY}-{TIER}{SOURCES}V-{TYPE}
| Component | Values | Description |
|---|
{COUNTRY} | AUS, NZL, USA, GBR | Three-letter country code |
{TIER} | Basic, Advanced | Essential or Enhanced tier |
{SOURCES}V | 1V, 2V, 3V | Number of verification sources |
{TYPE} | IDOnly, TwoPlus, TwoPlusID, AgeVerify | Verification method |
Examples:
| Workflow ID | Meaning |
|---|
AUS-Basic2V-TwoPlus | Australia, Essential tier, two sources, electronic verification |
USA-Advanced1V-IDOnly | United States, Enhanced tier, one source, ID + biometric verification |
GBR-Basic2V-TwoPlusID | United Kingdom, Essential tier, two sources, electronic + ID verification |
Discovering Available Workflows
You can retrieve the list of workflows available to your account using the V2 API.
Endpoint:
Required Headers:
| Header | Required | Description |
|---|
api_key | Yes | Your API key provided by FrankieOne |
X-Frankie-CustomerID | Yes | Your Customer ID provided by FrankieOne |
Optional Headers:
| Header | Description |
|---|
X-Frankie-CustomerChildID | Child account identifier for multi-tenant setups |
X-Frankie-Channel | Channel identifier (e.g., api, portal, smartui) |
X-Frankie-Username | Username of the API caller |
Optional Query Parameters:
| Parameter | Description |
|---|
serviceName | Filter workflows by service name |
include | Include additional detail; supports workflowDefinition |
The response returns an array of workflow objects, each containing serviceName, workflowId, workflowName, type, and lifecyclePhase.
Note: The workflows available to your account depend on your FrankieOne configuration. Not all workflow IDs listed in this guide may be available. Use this endpoint to confirm which workflows are configured for your account.
Australian (AU) Workflows
Australia has the most comprehensive range of workflow bundles, designed to meet Australian AML/CTF requirements.
Essential AU Bundles
1. AU Essential Identity (ID Only)
| |
|---|
| Workflow ID | AUS-Basic1V-IDOnly |
| Common Name | Basic ID Check, Government ID Verification |
What It Does: Verifies a single government-issued ID against the Document Verification Service (DVS). Performs standard AML screening (PEP & Sanctions) and calculates a risk assessment.
Checks Included: Blocklist, Government ID verification (DVS), AML screening (PEP & Sanctions), Risk assessment.
Typical Use Cases: Low-risk digital onboarding, e-commerce platforms, digital service sign-ups.
2. AU Essential Identity — Two Sources
| |
|---|
| Workflow ID | AUS-Basic2V-TwoPlus |
| Common Name | 2+2 Verification, Electronic Verification |
What It Does: Matches customer data against two independent electronic data sources to meet standard 2+2 verification requirements. No document scanning required. Performs standard AML screening.
Checks Included: Blocklist, KYC check (2+2 rule — verifies against 2 data sources), AML screening (PEP & Sanctions), Risk assessment.
Typical Use Cases: Standard bank account opening, credit applications, insurance onboarding, utility account setup.
Note: The specific data sources used (e.g., credit bureaus, electoral rolls) are configured by FrankieOne and may vary by customer.
3. AU Essential Identity — Two Sources & ID
| |
|---|
| Workflow ID | AUS-Basic2V-TwoPlusID |
| Common Name | 2+2 Plus ID, Enhanced Electronic Verification |
What It Does: Combines 2+2 electronic verification with a government ID check for a higher level of assurance.
Checks Included: Blocklist, Government ID verification (DVS), KYC check (2+2 rule), AML screening (PEP & Sanctions), Risk assessment.
Typical Use Cases: Mortgage applications, investment accounts, higher-value transactions, regulated financial products.
4. AU Essential Identity — Three Sources
| |
|---|
| Workflow ID | AUS-Basic3V-TwoPlus |
| Common Name | Extended 2+2, Three Source Verification |
What It Does: Uses three independent data sources for verification. Provides a fallback when initial two sources don’t yield results. Useful for customers with thin credit files.
Checks Included: Blocklist, KYC check (2+2 rule with 3 sources), AML screening (PEP & Sanctions), Risk assessment.
Typical Use Cases: First-time credit applicants, customers with thin credit files, recent immigrants, fallback verification.
Enhanced AU Bundles
5. AU Enhanced Identity (ID Only)
| |
|---|
| Workflow ID | AUS-Advanced1V-IDOnly |
| Common Name | Enhanced ID Verification, Biometric Verification |
What It Does: Mandatory government ID verification and IDV (document authenticity + biometric checks). Enhanced AML screening including Adverse Media.
Checks Included: Blocklist, Government ID verification (DVS), IDV (document authenticity, liveness detection, face match), Enhanced AML screening (PEP, Sanctions, Adverse Media), Risk assessment.
Typical Use Cases: Cryptocurrency exchanges, high-value lending, wealth management, international money transfers.
6. AU Enhanced Identity — Three Sources & ID
| |
|---|
| Workflow ID | AUS-Advanced3V-TwoPlusID |
| Common Name | Maximum Verification, Comprehensive Due Diligence |
What It Does: The most thorough verification bundle available. Combines government ID, biometrics, enhanced AML, and three data sources.
Checks Included: Blocklist, Government ID verification (DVS), KYC check (2+2 rule with 3 sources), IDV (document authenticity, liveness, face match), Enhanced AML screening (PEP, Sanctions, Adverse Media), Risk assessment.
Typical Use Cases: Private banking, high-net-worth individuals, large cryptocurrency transactions.
Specialised AU Bundles
7. AU Age Verification
| |
|---|
| Workflow ID | AUS-Basic3V-AgeVerify |
| Common Name | Age Check, 18+ Verification |
What It Does: Specialised workflow for age verification. Confirms the customer is above a specified age. Verifies date of birth against multiple data sources. Does not perform full identity verification.
Checks Included: Blocklist, KYC check (age verification focus), AML screening (PEP & Sanctions), Risk assessment.
Typical Use Cases: Online gambling, alcohol delivery, tobacco e-commerce, age-restricted digital services.
New Zealand (NZ) Workflows
New Zealand bundles are similar to Australian bundles but use NZ-specific data sources.
| Workflow ID | Type | Description |
|---|
NZL-Basic1V-IDOnly | Essential | Government ID verification only |
NZL-Basic2V-TwoPlus | Essential | Electronic 2+2 verification |
NZL-Basic2V-TwoPlusID | Essential | Electronic + ID verification |
NZL-Advanced1V-IDOnly | Enhanced | ID + biometric verification |
NZL-Advanced3V-TwoPlusID | Enhanced | Maximum verification |
Check composition follows the same pattern as the equivalent AU workflows. Data sources are NZ-specific and configured by FrankieOne.
United States (US) Workflows
US bundles are designed to meet US regulatory requirements and use US-specific data sources.
| Workflow ID | Type | Description |
|---|
USA-Basic1V-IDOnly | Essential | Government ID verification only |
USA-Basic2V-TwoPlus | Essential | Electronic verification |
USA-Basic2V-TwoPlusID | Essential | Electronic + ID verification |
USA-Advanced1V-IDOnly | Enhanced | ID + biometric verification (may include OFAC screening) |
USA-Advanced3V-TwoPlusID | Enhanced | Maximum verification |
USA-eID-Express | Specialised | Identity verification with prefilled data |
US eID Express (Prefill)
| |
|---|
| Workflow ID | USA-eID-Express |
| Common Name | Instant Verification, Prefill Verification |
What It Does: Provides identity verification with prefilled data. Given minimal input (e.g., mobile number and date of birth), FrankieOne can retrieve and prefill additional identity fields such as name and SSN from verified data sources, reducing friction in the onboarding flow.
Checks Included: Blocklist, eID verification (prefill), AML screening (PEP & Sanctions), Risk assessment.
How It Works: The customer provides minimal identifying information. FrankieOne retrieves and prefills additional identity data from verified sources. The customer confirms or corrects the prefilled information. Identity verification and AML screening are then performed.
Typical Use Cases: FinTech applications, digital wallets, instant account opening, low-friction onboarding flows.
Note: The specific data sources and fields available for prefill are configured by FrankieOne and may vary. Contact your representative for details.
United Kingdom (UK) Workflows
UK bundles are designed to meet UK regulatory requirements, including FCA requirements for customer due diligence.
| Workflow ID | Type | Description |
|---|
GBR-Basic1V-IDOnly | Essential | Government ID verification only |
GBR-Basic2V-TwoPlus | Essential | Electronic verification |
GBR-Basic2V-TwoPlusID | Essential | Electronic + ID verification |
GBR-Advanced1V-IDOnly | Enhanced | ID + biometric verification |
GBR-Advanced3V-TwoPlusID | Enhanced | Maximum verification |
Check composition follows the same pattern as AU workflows. Data sources are UK-specific and configured by FrankieOne.
Specialised Workflows
AML-Only Workflows
| Workflow ID | Description |
|---|
AML-Only-Standard | AML screening only (PEP & Sanctions). No identity verification. |
AML-Only-Enhanced | Enhanced AML screening (PEP, Sanctions, Adverse Media). No identity verification. |
Use these for re-screening existing customers or performing standalone AML checks on already-verified entities.
Ongoing Monitoring
FrankieOne supports ongoing AML monitoring. Once enabled for an entity, FrankieOne automatically screens the entity periodically and can send alerts on status changes (e.g., if the entity is added to a sanctions list).
Monitoring is managed via the V2 API:
PATCH /v2/individuals/{entityId}/monitor?enabled={true|false}&monitoringTypes={AML|ACTIVITY}
The enabled query parameter (required) toggles monitoring on or off. The monitoringTypes query parameter specifies the type of monitoring (AML, ACTIVITY, or omit to apply to all types). The request body accepts an optional comment object.
Note: Monitoring configuration (frequency, alert thresholds) is managed by FrankieOne, not controlled via the API.
Re-Verification
Workflow ID pattern: Refresh-KYC-{Country}
Re-verifies existing customers by running updated KYC and AML checks. Use for periodic re-verification or when customer information has changed.
Note: The specific workflow IDs listed in this section (AML-Only, Monitoring, Refresh-KYC) are representative. Use GET /v2/workflows to confirm which workflows are configured for your account.
Choosing the Right Workflow
Decision Framework
Step 1: Identify Your Region
| Region | Workflow Prefix |
|---|
| Australia | AUS- |
| New Zealand | NZL- |
| United States | USA- |
| United Kingdom | GBR- |
Step 2: Determine Risk Level
| Risk Level | Bundle Type | When to Use |
|---|
| Low | Essential | Standard customers, low-value transactions |
| Medium | Essential with ID | Medium-value transactions, regulatory requirements for ID |
| High | Enhanced | High-value transactions, regulated industries |
| Very High | Enhanced with multiple sources | Maximum due diligence, highest-risk scenarios |
Step 3: Choose Verification Method
| Method | Workflow Type | Pros | Cons |
|---|
| ID Only | {TIER}1V-IDOnly | Fast, simple | Requires government ID |
| Electronic (2+2) | {TIER}2V-TwoPlus | No document needed | May not work for all customers |
| Electronic + ID | {TIER}2V-TwoPlusID | Higher assurance | Requires ID and data match |
| Extended | {TIER}3V-TwoPlusID | Works for thin-file customers | Higher cost |
Step 4: Consider Special Requirements
| Requirement | Workflow |
|---|
| Age verification only | AUS-Basic3V-AgeVerify |
| Instant verification (US) | USA-eID-Express |
| AML screening only | AML-Only-Standard or AML-Only-Enhanced |
| Ongoing monitoring | Enable via PATCH /v2/individuals/{entityId}/monitor |
| Re-verification | Refresh-KYC-{Country} |
Example Scenarios
Australian E-Commerce (age-gated products): AUS-Basic3V-AgeVerify — designed for age verification, no document upload, suitable for high volume.
US Cryptocurrency Exchange: USA-Advanced1V-IDOnly or USA-Advanced3V-TwoPlusID — mandatory document and biometric verification, enhanced AML screening.
Australian Digital Bank: AUS-Basic2V-TwoPlus as primary, with AUS-Basic2V-TwoPlusID as a fallback — meets 2+2 requirements, electronic verification for most customers.
UK Wealth Management: GBR-Advanced3V-TwoPlusID — maximum verification, enhanced AML, designed for FCA enhanced due diligence.
US FinTech App: USA-eID-Express — prefill-based verification, no document upload, low-friction onboarding.
Workflows in V2 are configured and managed by FrankieOne. They are not self-service editable via the API or Portal.
To customise a workflow:
- Contact your FrankieOne representative.
- Discuss your requirements (checks needed, risk thresholds, data sources, regulatory obligations).
- FrankieOne configures or modifies the workflow.
- Test in UAT, then deploy to production.
What can be customised:
- Add or remove checks
- Change check order
- Adjust pass/fail thresholds
- Modify data sources
- Create custom workflows
- Clone and modify standard bundles
Timelines:
- Simple changes: 1–2 business days
- Standard customisations: 3–5 business days
- Complex customisations: 5–10 business days
V1 Entity Profiles (Recipes)
Note: V1 is the legacy API. V2 is recommended for all new integrations. Both remain supported.
Key Differences
| Aspect | V1 (Legacy) | V2 (Current) |
|---|
| Terminology | Entity Profiles / Recipes | Workflows / Workflow Bundles |
| Self-Service Editing | No — configured by FrankieOne | No — configured by FrankieOne |
| Naming | Custom names per customer | Standardised naming convention |
| Execution | Assign profile to entity | Execute workflow on entity |
| Portal | View profiles in Portal | View workflows in Portal |
V1 Portal Access
| Environment | Portal URL |
|---|
| Production | https://portal.kycaml.frankiefinancial.io/login |
| UAT | https://portal.kycaml.uat.frankiefinancial.io/login |
In V1, you can view your entity profiles (recipes) in the Portal under Settings → Workflow Builder. Profiles are configured by FrankieOne — contact your representative for any changes.
V1 API Base URLs
| Environment | Base URL |
|---|
| Production | https://api.kycaml.frankiefinancial.io/compliance/v1.2/ |
| UAT | https://api.kycaml.uat.frankiefinancial.io/ |
Should You Migrate to V2?
V2 is the current standard. Benefits include standardised naming, improved documentation, and a more consistent structure. Migration is available — contact your FrankieOne representative to plan the process.
FAQs
Can I use multiple workflows for different customer types?
Yes. You can configure different workflows for different customer segments, products, or risk levels. Each workflow execution is independent.
Can I run multiple workflows on the same entity?
Yes. You can execute different workflows on the same entity — for example, an onboarding workflow followed by a monitoring workflow. Each execution is independent.
Can I edit workflows myself?
No. Workflows are configured by FrankieOne in both V1 and V2. Contact your FrankieOne representative to request changes.
How do I know which workflows are available to my account?
Use the GET /v2/workflows endpoint. This returns the list of workflows configured for your account.
What if I need a workflow for a country not listed here?
FrankieOne supports verification in 200+ countries. Contact your representative to discuss country-specific workflow configuration.
Can I test workflows before production?
Yes. Always test in the UAT environment first. V2 UAT base URL: https://api.uat.frankie.one. V2 UAT Portal: https://portal.uat.frankie.one/login.
How much do different workflows cost?
Pricing varies by workflow and check composition. Contact your FrankieOne representative for specific pricing.
Environments
V2 (Current)
| Environment | API Base URL | Portal URL |
|---|
| Production | https://api.frankie.one | https://portal.frankie.one/login |
| UAT | https://api.uat.frankie.one | https://portal.uat.frankie.one/login |
V1 (Legacy)
| Environment | API Base URL | Portal URL |
|---|
| Production | https://api.kycaml.frankiefinancial.io/compliance/v1.2/ | https://portal.kycaml.frankiefinancial.io/login |
| UAT | https://api.kycaml.uat.frankiefinancial.io/ | https://portal.kycaml.uat.frankiefinancial.io/login |
Getting Help
Contact: Email help@frankieone.com or your FrankieOne representative.
When contacting support, include your Customer ID (X-Frankie-CustomerID), the workflow ID in question, and a description of what you’re trying to achieve.
Resources: