...
📁 Table of Contents
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:
Code Block |
---|
npm install @ondato-public/idv-sdk |
...
☑️ Prerequisites
Adjusted .npmrc file with custom 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
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
📂 Getting started with javascript Script
To begin, run the following command:
Code Block |
---|
<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
Expand | ||
---|---|---|
| ||
|
...
🔀 Flows explained
To illustrate how to implement flows, consider the following code snippet:
Code Block |
---|
import { load } from '@ondato-public/idv-sdk'; const exampleSdk = load({ mode: SdkMode.Sandbox }); |
...
1️⃣ load()
Info |
---|
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
⚠️ Possible exceptions:
|
...
2️⃣ exampleSdk.idv.customiseStyleonload()
Info |
---|
|
Expand | ||
---|---|---|
| ||
|
...
3️⃣ exampleSdk.idv.begin()
Info |
---|
|
Expand | ||||
---|---|---|---|---|
| ||||
⚠️ Possible exceptions:
|
...
4️⃣ exampleSdk.idv.end()
Info |
---|
|
...
5️⃣ How to generate IDV ID?
Generate idvID fromhttps://sandbox-idvapi.ondato.com/swagger/index.html →
Status colour Green title 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.
...
🗒️ Changelog 🔗
...