Skip to main content

Subscription Required

Hosted OneSDK is available through a monthly subscription. Contact your customer success manager to get started. Our team will handle the setup process for you.

Overview

Hosted OneSDK Overview

Automatic Updates

Stay current with automatic security and compliance updates

Low-Code Solution

Minimize engineering effort and accelerate deployment

Multi-Platform

Single API for both web and mobile applications

Managed Service

FrankieOne handles hosting and maintenance

Key Benefits

  • Unified API integration for web and mobile
  • Managed hosting and maintenance
  • Automatic feature updates
  • Flexible deployment options (iFrame/WebView)
  • Faster time to market
  • Reduced development costs
  • Enhanced security compliance
  • Improved user onboarding experience

Implementation Guide

1

Generate Onboarding URL

Use the Hosted Onboarding API to create your URL.
Flow IDPurpose
doc_uploadDocument attachment for business entities
idvComplete IDV flow with OCR and Biometrics
idv_reviewIDV flow with user review/edit capability
individual_doc_uploadDocument attachment for individual entities
manual_kyceKYC-only flow
ocr_onlyDocument OCR without biometrics
{
  "applicationRef": "UNIQUE_APPLICATION_REF",
  "customerRef": "UNIQUE_REFERENCE",
  "consent": true,
  "flowId": "idv",
  "phoneNumber": "04xxxxxxxx",
  "phoneCode": "+61",
  "recipientName": "TEST",
  "sendSMS": true
}
SMS Delivery
Enable automatic SMS delivery by setting sendSMS: true and providing a phoneNumber. Contact Technical Support to customize SMS content and URL expiry.
2

Configure Entity Profile (Optional)

Update the entity profile to specify verification requirements:
{
  "entityId": "your_entity_id",
  "entityProfile": "your_recipe_name"
}
3

Implement URL Handling

webAppInterface = WebAppInterface(requireContext())
binding.webView.apply {
    webViewClient = MyWebViewClient()
    webChromeClient = MyWebChromeClient()
    addJavascriptInterface(webAppInterface, "Android")
    loadUrl("https://verify.uat.frankie.one?t=dFLfq4pbfMfnWUZ4SR8W5i")
}

Portal Integration

The Portal provides additional capabilities for managing onboarding URLs and document collection.

Sending Onboarding URLs

1

Access Entity Profile

Navigate to the entity profile page or create a new profile
2

Generate QR Code

QR Code Example
3

Track Progress

Monitor profile updates as users complete onboarding

Document Collection

Production Endpoint:
POST https://api.frankie.one/idv/v2/idvalidate/onboarding-url
UAT Endpoint:
POST https://api.uat.frankie.one/idv/v2/idvalidate/onboarding-url
Headers:
X-Frankie-Customerid: YOUR_CUSTOMER_ID
X-Frankie-CustomerChildID: YOUR_CUSTOMER_CHILD_ID
api_key: YOUR_API_KEY
Individual Document Upload flow has 3 different document types:
  • Required documents requestedDocuments
  • Partial documents partialDocuments, which can consists of multiple groups with configurable title and minimum required document per groups
  • Optional documents optionalDocuments
{
  "flowId": "individual_doc_upload",
  "senderName": "OneSDK-Testing-Sender-Name",
  "requestedDocuments": [
  {
        "documentType": "BIRTH_CERT"
      },
      {
        "documentType": "CITIZENSHIP"
      }
],
  "partialDocuments": [
      {
        "title": "Additional Documents",
        "minimumRequirement": 2,
        "documents": [
          {
            "documentType": "VISA"
          },
          {
            "documentType": "UTILITY_BILL"
          },
          {
            "documentType": "VEHICLE_REGISTRATION"
          }
        ]
      }
  ],
  "optionalDocuments": [
      {
        "documentType": "NAME_CHANGE"
      },
      {
        "documentType": "MARRIAGE_CERT"
      }
  ],
  "entity": {
    "entityId": "bc335f79-c167-36f6-3c70-d3c0a2d8c8b8"
  }
}
{
  "flowId": "doc_upload",
  "senderName": "OneSDK-Testing-Sender-Name",
  "requestedDocuments": [
    {
      "documentType": "BANK_STATEMENT"
    },
    {
      "documentType": "TRUST_DEED"
    }
  ],
  "entity": {
    "entityId": "bc335f79-c167-36f6-3c70-d3c0a2d8c8b8"
  }
}
Documents will appear in the “Supporting Documents” tab of the business entity’s Portal profile once uploaded.