Jump to Content
FrankieOne
HomeDocumentationAPI ReferenceRelease Notes
Log InFrankieOne
Log In
HomeDocumentationAPI ReferenceRelease Notes

Welcome to Frankie!

  • Welcome to FrankieOne!
  • Integrating with FrankieOne
  • FrankieOne Release Notes
  • FrankieOne Release Approach
  • Customer FAQs
  • Getting Help: Contacting Developer Support

Notices

  • AUS: DVS Drivers Licence Changes

Developer Quickstart

  • Get started with the Quickstart

KYC (Individuals)

  • KYC Information
    • KYC Overview
    • About entity profiles
    • About consent
    • Getting started with KYC
    • IDV Service flows
  • KYC integration information
  • How-tos and guides
  • Verifying customers
  • Understanding check results
    • The Process Result Object
    • Check Results - Summaries
    • Understanding CheckSummary Results
    • Check Risk Results
    • Duplicate Check Results
    • Blocklist Check Results
    • Manual Check Results
  • Understanding entity profile KYC results
  • Understanding entity profile verification
  • Understanding AML Results
    • AML Result Set Breakdown
    • BackgroundCheckResultObject (BCRO)
    • AML Result Set Elements
    • Example AML Result Sets
  • Understanding special results sets
    • Credit Header Results - How to Read
    • Australian Visa Entitlement Check Results
  • Importing past KYC check data
    • Import Using Multiple KVPs
    • Import Using a Single KVP
  • KYC API reference

KYB (Businesses)

  • Overview
  • Get started with International KYB
    • Search For a Business
    • Retrieve a Business Profile
    • Getting a List of Documents from Catalogue
    • UBO Visual Ownership Tree (Beta)
    • Order a document from Catalogue
    • Status of a Document Order
    • Retrieving a Requested Document
    • Supported country codes
    • ibResponseCode Values
    • International KYB Flows and Sequence
  • Australian businesses
    • Business Look Up - Australia
    • Create a business entity
    • Business ownership query
    • Understanding business ownership query results
    • Business Ownership Issues List
    • Perform Checks for Associated Individuals
    • Run Credit Reports
    • Australian KYB Functional Call Flow
    • Flows and Sequence Diagram
    • Manage associated entities for a Business
    • Retrieve Parent Associations

FRAUD & TRANSACTION MONITORING)

  • Overview
    • Key concepts
  • Use cases
  • How fraud & transaction monitoring works
  • Get started
  • Features
  • Onboarding and monitoring customers with Fraud & Transaction Monitoring issues
  • Integrate Fraud and Transaction Monitoring features
    • Phone and email screening
    • Phone and email screening + Device and behavioral characteristics screening
    • Phone and email screening + device and behavioural characteristics + Transaction monitoring
  • Onboarding and monitoring customers with Fraud & Transaction Monitoring issues

API

  • Introduction to the API
  • Common API Objects and Fields
    • Object IDs
    • The Document Object
    • The Entity Object
    • Key Value Pairs
    • RequestID
  • Basic API Principles
    • Adding Data With The API
    • Updating Data Through the API
    • Performing Actions with the API
  • Asynchronous Calls (Background Processes)
  • Notifications - Webhooks
    • Securing Webhook Endpoints with JWT
    • When can I /retrieve data?
  • Working with Names
    • Names With Different Character Sets
    • Verifying Single Name Applicants
  • Middle Name Matching with Australian Data Sources
  • Working With Addresses
  • Working With Country Codes
  • Working With Support Docs
  • Entity extraData Key Value Pairs
    • Customer Reference Number
  • Requirements & Additional Fields for ID Documents
    • AUS: Driver's Licence
    • AUS: Passport
    • AUS: Visa
    • AUS: Medicare Card
    • AUS: Name Change Certificate
    • AUS: Birth Certificate
    • AUS: Citizenship
    • AUS: Marriage Certificate
    • NZL: Driver's Licence
    • NZL: Passport
    • NZL: Motor Vehicle Registration
    • NZL: Citizenship Certificate
    • NZL Birth Certificate
    • CHN: National ID
    • MEX: National ID
    • THA: National ID
    • International: Passport
    • International: National ID
  • Adding an Email Address
  • Adding a Mobile Phone Number
  • OCR extraction API
  • Working with the Sandbox
    • Using the Sandbox Data and API
    • Forcing Errors in Test Scenarios
    • Typical Test Scenarios
  • Download Test Data

Portal

  • Getting Started with the FrankieOne Portal
    • Multi-factor Authentication
  • Dashboard
  • What is a recipe?
    • Updating a legacy customer profile to use a Recipe
  • Monitoring and Onboarding lists
  • Profile Status and Issue Tags
  • Customer Profiles - Individuals (KYC)
    • What is a Customer Profile?
    • KYC/Personal Info Tab
    • Create a new profile via the portal
    • Edit Customer Information
    • Change a Customer's Recipe
    • Individual Verification Report
    • Vevo
    • Biometrics
    • Biometrics and OCR Check Results
    • Manually Overriding Biometrics/OCR Results
    • Risk Assessment
    • Manual KYC Verification
    • A note on middle names
  • Customer Profile - Business (KYB)
    • Checks and Reports Available for Businesses
    • Create a New Business Profile via the Portal
    • Run a check on a business that is not listed on ABR
    • Managing Associated Parties
  • Blocklists and Watchlists
    • Add and remove an entire profile from an internal blocklist
    • Adding profiles to the internal watchlist
    • Adding an individual attribute to the internal blocklist
    • Managing Internal Blocklist
    • What types of profiles and attributes can be added to the blocklist?
    • Resolving a potential blocklist match
  • Manage Users
    • Manage User Roles
    • Portal Permissions
  • Review and resolve potential AML matches
  • Managing Duplicates
  • How to archive and deactivate a customer in the portal
  • Configuring SSO with the FrankieOne portal
  • Resolving Digital IDs in Portal
  • Exporting all Customer Records

OneSDK

  • About OneSDK v0.8.x-alpha
  • Getting started
  • OneSDK for KYC
  • OneSDK for OCR and biometrics
  • OneSDK for Fraud detection and prevention
  • OneSDK for Federated Identity
  • Using OneSDK flows
    • IDV flow
  • Testing OneSDK
  • Using OneSDK with React
  • Using OneSDK with Rollup
  • OneSDK FAQ
  • SDK Version Log

Smart UI

  • Getting started with Smart UI
    • Sample apps
  • Biometrics / ID Validation Using Onfido
    • IdScanVerification version log
  • Customise the widget's appearance
  • Example configurations
  • Smart UI Configuration
  • Verifying custom documents
  • Pre-fill applicant data
  • Events
  • Version Log
  • Smart UI FAQ and Troubleshooting
  • CSP and Smart UI Security Recommendations
  • Migrating to version 4
    • Migrating from v3 to v4
    • Migrating from v2 to v3

Check Results - Details

Suggest Edits

The following pages will delve into the sections of the CheckEntityCheckResultObject that provide deep detail of the results.

  • Duplicate Check Results
  • Blocklist Check Results
  • Manual Check Results
  • Check Risk Results
  • AML Results

Updated about 19 hours ago