đ Table of Contents
âšī¸ Introduction
The current flow only allows using the Web Browser SDK by installing it through npmđ or using it as a scriptđ.
đĸ Latest version
Latest Major version is v2.x.x
Refer to Changelog for latest versions and changes.
đĨ Compatibility
đĸ Supported: Only web browsers (Chrome, Firefox, Safari, Edge etc.).
đ´ Not supported: Native application languages like React-Native, Flutter etc.
đ Getting started with npm
To begin, run the following command:
npm install @ondato-public/idv-sdk
âī¸ Prerequisites
Adjusted .npmrc file with custom registry.
@ondato-public:registry=https://pkgs.dev.azure.com/Ondato/PublicNPM/_packaging/ondato-public-npm/npm/registry/
Obtain your unique idv setupId. Process configuration is specified based on your needs.
Please reach out to [support@ondato.com] for assistance.
The SDK can be utilized by generating an idv ID or by using idv setupId (where the idv id is generated automatically)
Verify the Web browser version limitations.
Refer to the documentation here.
Review npm examples for a better understanding.
đī¸ Example npm
đ Typescript:
Full TypeScript support is available. Full list *.d.ts types can be downloaded from scriptđ examples or when installed through npmđ.
đ Getting started with javascript Script
To begin, run the following command:
<script src="{baseUrl}/ondato-sdk.2.x.x.min.js"></script>
âī¸ Prerequisites
Ensure the script is configured with the correct ondato-sdk library build file in the index.html.
Obtain your unique idv setupId. Process configuration is specified based on your needs.
Please reach out to [support@ondato.com] for assistance.
The SDK can be utilized by generating an idv ID or by using idv setupId (where the idv id is generated automatically)
Verify the Web browser version limitations.
Refer to the documentation here.
đī¸ Example script
đ Flows explained
To illustrate how to implement flows, consider the following code snippet:
import { load } from '@ondato-public/idv-sdk'; const exampleSdk = load({ mode: SdkMode.Sandbox });
1ī¸âŖ load()
Purpose: To invoke the initial Web SDK instance.
Return: On success, it provides the
idv.begin()
andidv.end()
methods.Accepted property: The
mode
interface (used for setting the environment).
2ī¸âŖ exampleSdk.idv.customiseStyleonload()
Purpose: This function enables customization of certain CSS styles within the SDK.
Accepted property:
({ background: { opacity: 0, blur: '0' } })
3ī¸âŖ exampleSdk.idv.begin()
Purpose: Creates idv session.
Accepted property: idvSetupId, idvId, language, onSuccess, onFailure, onClose
4ī¸âŖ exampleSdk.idv.end()
Purpose: Closes SDK application without error. Cleans up all sdk tasks and application.
Accepted property:
None
5ī¸âŖ How to generate IDV ID?
Generate idvID fromhttps://sandbox-idvapi.ondato.com/swagger/index.html → POST
/v1/identity-verifications
Provide correct and existing setupId.
Each unique session requires a new generation
â Frequently Asked Questions (FAQs)
Why should both the
begin()
andload()
methods be used within a try-catch block?Both methods should be utilized within a try-catch block to ensure proper error handling.
What happens to the session id during an F5 (page refresh)?
In the event of an F5 (page refresh), the same session id will be retained, allowing the same session to be loaded seamlessly.
Where can I find a list of available languages?
For a list of available languages, refer to the documentation here: https://ondato.atlassian.net/wiki/spaces/PUB/pages/2520809520/Localization#%F0%9F%97%A3%EF%B8%8F-Supported-languages
What is IdvId and idv setupId
Idv id is process session id (each session has a uniquely generated idvId), and idv setupid id is unique static client configration id (static id always remains the same)
What is Idv
Idv is a shortname and stands for identity verification.
Add Comment