Hosted Common Use Cases

Hosted OneSDK Hosted OneSDK offers a low-code solution, allowing customers to easily integrate with FrankieOne services with little to no code. Hosted OneSDK automatically updates, ensuring a consistent, secure, and compliant integration. This reduces engineering and security efforts, helping you go live faster.

Below are sample out-of-the-box flows that we offer for Hosted OneSDK.

We also support customisations of themeing, branding and flows for Hosted OneSDK. Contact FrankieOne Support to get started.

eKYC Forms Flow

The eKYC Forms Flow on the Hosted OneSDK allow customers to embed or send their end-users a link with a fixed set of forms that allow PII data to be captured and used for KYC. Customers will gain access to the following screens in sequence with no ability to make any modifications.

eKYC Forms Flow User Journey
Generating Hosted OneSDK Link with eKYC Forms Flow

Creating a POST Request with following headers and request Body

		curl --location 'https://api.kycaml.frankiefinancial.io/idv/v2/idvalidate/onboarding-url' \
		--header 'X-Frankie-Customerid: CUSTOMER_ID' \
		--header 'api_key: API_KEY' \
		--header 'Content-Type: application/json' \
		--data '{
				"customerRef": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING",
				"consent": true,
				"flowId": "manual_kyc"
		}'

will return object:

{
	"status": "success",
	"url": "https://verify.frankie.one?t=qWfYeYy40taNdMC2nTgpRh",
	"entity": {
		"entityId": "50768f69-4e9b-1f5d-651f-7796fef775e8",
		"entityProfile": "default",
		"entityType": "INDIVIDUAL",
		"extraData": [
			{
				"kvpKey": "consent.general",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.docs",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.creditheader",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.superannuation",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "customer_reference",
				"kvpType": "id.external",
				"kvpValue": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING"
			}
		],
		"name": {
			"familyName": ""
		}
	},
	"urlExpiry": "2024-12-07T02:42:21.655079919Z"
}

where url will contain the link to our Hosted OneSDK Solution. To read more, go here.

IDV Flow

The IDV flow is a combination of the vendors SDK all-in-one where the customer goes through the process of (1) capturing their document and (2) running the selfie and liveness checks.

IDV Only User Journey
Generating Hosted OneSDK Link with IDV Only Flow

Creating a POST Request with following headers and request Body

		curl --location 'https://api.kycaml.frankiefinancial.io/idv/v2/idvalidate/onboarding-url' \
		--header 'X-Frankie-Customerid: CUSTOMER_ID' \
		--header 'api_key: API_KEY' \
		--header 'Content-Type: application/json' \
		--data '{
				"customerRef": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING",
				"consent": true,
				"flowId": "idv"
		}'

will return object:

{
	"status": "success",
	"url": "https://verify.frankie.one?t=qWfYeYy40taNdMC2nTgpRh",
	"entity": {
		"entityId": "50768f69-4e9b-1f5d-651f-7796fef775e8",
		"entityProfile": "default",
		"entityType": "INDIVIDUAL",
		"extraData": [
			{
				"kvpKey": "consent.general",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.docs",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.creditheader",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "consent.superannuation",
				"kvpType": "general.string",
				"kvpValue": "true"
			},
			{
				"kvpKey": "customer_reference",
				"kvpType": "id.external",
				"kvpValue": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING"
			}
		],
		"name": {
			"familyName": ""
		}
	},
	"urlExpiry": "2024-12-07T02:42:21.655079919Z"
}

where url will contain the link to our Hosted OneSDK Solution. To read more, go here.

IDV + Review Screen Flow

IDV + Review Scren User Journey
Generating Hosted OneSDK Link with IDV Only Flow

Creating a POST Request with following headers and request Body

		curl --location 'https://api.kycaml.frankiefinancial.io/idv/v2/idvalidate/onboarding-url' \
		--header 'X-Frankie-Customerid: CUSTOMER_ID' \
		--header 'api_key: API_KEY' \
		--header 'Content-Type: application/json' \
		--data '{
				"customerRef": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING",
				"consent": true,
				"flowId": "idv_review"
		}'

will return object:

	{
	"status": "success",
	"url": "https://verify.frankie.one?t=qWfYeYy40taNdMC2nTgpRh",
	"entity": {
	"entityId": "50768f69-4e9b-1f5d-651f-7796fef775e8",
	"entityProfile": "default",
	"entityType": "INDIVIDUAL",
	"extraData": [
	{
	"kvpKey": "consent.general",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.docs",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.creditheader",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.superannuation",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "customer_reference",
	"kvpType": "id.external",
	"kvpValue": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING"
	}
	],
	"name": {
	"familyName": ""
	}
	},
	"urlExpiry": "2024-12-07T02:42:21.655079919Z"
	}

whereurl will contain the link to our Hosted OneSDK Solution. To read more, go here.

OCR Only Flow

OCR Only Flow on the Hosted OneSDK allow customers to embed or send their end-users a link with an OCR journey provided by Onfido / Incode, getting their data to be captured and used for KYC.

IDV Only User Journey
Generating Hosted OneSDK Link with IDV Only Flow

Creating a POST Request with following headers and request Body

		curl --location 'https://api.kycaml.frankiefinancial.io/idv/v2/idvalidate/onboarding-url' \
		--header 'X-Frankie-Customerid: CUSTOMER_ID' \
		--header 'api_key: API_KEY' \
		--header 'Content-Type: application/json' \
		--data '{
				"customerRef": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING",
				"consent": true,
				"flowId": "ocr_only"
		}'

will return object:

	{
	"status": "success",
	"url": "https://verify.frankie.one?t=qWfYeYy40taNdMC2nTgpRh",
	"entity": {
	"entityId": "50768f69-4e9b-1f5d-651f-7796fef775e8",
	"entityProfile": "default",
	"entityType": "INDIVIDUAL",
	"extraData": [
	{
	"kvpKey": "consent.general",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.docs",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.creditheader",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "consent.superannuation",
	"kvpType": "general.string",
	"kvpValue": "true"
	},
	{
	"kvpKey": "customer_reference",
	"kvpType": "id.external",
	"kvpValue": "YOUR_CUSTOMER_ID_OR_RANDOM_STRING"
	}
	],
	"name": {
	"familyName": ""
	}
	},
	"urlExpiry": "2024-12-07T02:42:21.655079919Z"
	}

whereurl will contain the link to our Hosted OneSDK Solution. To read more, go here.

Listening to Window Events with Hosted OneSDK

Hosted OneSDK will emit window events during specific stage of your onboarding experience. You can leverage this mechanism to handle error and success handling

Table of Events
Implementation method

flowId	On which stage?	Event Emitted	Payload
ocr_only	failed uploading OCR	`ocr_only:failed`	-
ocr_only	success uploading OCR	`ocr_only:success`	-
manual_kyc	manual kyc is mounted	`manual_kyc:mounted`	-
manual_kyc	success with manual kyc	`manual_kyc:success`	-
manual_kyc	partial success with manual kyc	`manual_kyc:partial`	-
manual_kyc	failed manual kyc	`manual_kyc:failed`	-
idv	idv is getting mounted	`idv:mount`	-
idv	idv process success	`idv:success`	-
idv	idv process failed	`idv:failed`	-
idv	idv getting rendered	`idv:render`	-
idv_review	idv_review is getting mounted	`idv_review:mount`	-
idv_review	idv_review getting rendered	`idv_review:render`	-
idv_review	idv was failed on idv_review flow	`idv_review:idv_failed`	(error message depends on error type)
idv_review	after submitting review screen	`idv_review:submit`
idv_review	idv_review process is success	`idv_review:success`	result from calling `individual.submit()`sample: { "payload": { "checkDate": "0001-01-01T00:00:00.000Z", "checkTypes": [ "id", "namev", "two_plus", "pep", "idvalidate" ], "personalChecks": { "name": null, "dateOfBirth": null, "phoneNumber": null, "email": null, "chineseName": null, "addresses": { "4021e881-e51a-48ab-b8db-82cdc882d1a2": null } }, "status": { "type": "unchecked", "label": "Unchecked", "key": "UNCHECKED" }, "risk": { "level": null, "class": "HIGH" }, "alertList": [], "blocklistPotentialMatches": [], "duplicatePotentialMatches": [], "duplicateBlocklistMatches": [], "checkCounts": { "name": null, "address": { "4021e881-e51a-48ab-b8db-82cdc882d1a2": [] }, "document": {}, "dob": null }, "kycMethod": "electronic", "issues": { "creditHeader": false, }, "checkResults": [], "rulesetsMatches": [] } }
idv_review	during idv_review, there are some issues occurred	`idv_review:error`	`{ error: {} // object of dumped errors }`

You can listen to Hosted OneSDK window events if you embed Hosted OneSDK inside an iframe

<html lang="en">
    <head>
    	<meta name="viewport" content="width=device-width, initial-scale=1.0" charset="UTF-8"/>
    	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    </head>

	<script>
        // here, you add an event listener to listen to Hosted OneSDK window events
		window.addEventListener('message', (e) => {
			if (e.data['X-Frankie-Source'] === 'hosted-onesdk') {
				console.log('---HOSTED OneSDK events', e.data)
			}
		});
	</script>

	<body>
		<iframe
		style="position: absolute; top: 0; left: 0; left: 0;right: 0;bottom: 0;border: 0;margin: 0; padding: 0;width: 100%; height: 100%; fontSize: 100%;font: inherit; vertical-align: baseline;"
		src="https://verify.frankie.one?t=wy2BSoBrMYba7dB4cHS5dLjK" allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;geolocation;microphone;" />
	</body>
</html>

About OneSDK

​eKYC Forms Flow

​IDV Flow

​IDV + Review Screen Flow

​OCR Only Flow

​Listening to Window Events with Hosted OneSDK

eKYC Forms Flow

IDV Flow

IDV + Review Screen Flow

OCR Only Flow

Listening to Window Events with Hosted OneSDK