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

Developer Quickstart

  • Quickstart
  • Create an entity

KYC (Individuals)

  • Overview
  • Entity Profiles/Recipes - Introduction
  • Using an Entity Profile / Recipe
  • Understanding Check Results
    • The Process Result Object
  • Understanding Entity Profile KYC Results
  • Check Results - Summaries
    • Understanding CheckSummary Results
    • Interpreting CheckSummary Results
  • Understanding AML Results
    • AML Result Set Breakdown
    • BackgroundCheckResultObject (BCRO)
    • AML Result Set Elements
    • Example AML Result Sets
  • Check Results - Details
    • Duplicate Check Results
    • Blocklist Check Results
    • Manual Check Results
    • Check Risk Results
  • Special Result Sets
    • Credit Header Results - How to Read
    • Australian Visa Entitlement Check Results
  • ID Photo Validation Service Flows
  • Import Past KYC Check Data
    • Import Using Multiple KVPs
    • Import Using a Single KVP

KYB (Businesses)

  • Overview
  • Get started with International KYB
    • Search For a Business
    • Retrieve a Business Profile
    • Getting a List of Documents from Catalogue
    • Order a document from Catalogue
    • 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
    • Perform Checks for Associated Individuals
    • Run Credit Reports
    • Australian KYB Functional Call Flow
    • Flows and Sequence Diagram
    • Manage associated entities for a Business

Fraud & Transaction Monitoring

  • Overview
  • How fraud & transaction monitoring works
  • Get started
  • 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
    • Consent Flags
  • 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
  • Working with the Sandbox
    • Using the Sandbox Data and API
    • Entity Profiles/Recipes Available to Test With
    • Forcing Errors in Test Scenarios
  • Download Test Data

Portal

  • Getting Started with the FrankieOne Portal
  • Dashboard
  • What is 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
    • Vevo
    • Biometrics
    • Biometrics and OCR Check Results
    • Manually Overriding Biometrics/OCR Results
    • Risk Assessment
    • Updating a legacy customer profile to use a recipe
    • 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

Smart UI

  • Smart UI Overview
  • Obtaining the Smart UI Widget
  • Getting Started
  • Quickstart: Working Examples
  • ID Validation Using Onfido
  • Smart UI Configuration
  • Custom Styling
  • Preloading Existing Applicants
  • Events
  • Moving from Demo to Production
  • 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
  • Future Product Roadmap

Quickstart

Suggest Edits

Get up and running quickly with these examples. Note that you will need to add in your APIKey and CustomerID. If you do not have these yet then please contact FrankieOne.

📘

Examples are kept in github

See the examples here: https://github.com/FrankieFinancial/apiexamples

Updated about 2 months ago


What’s Next
  • Create an entity
Did this page help you?