JavaScript

This document explains how to integrate the Authentication flow from your web application

Orba One

To integrate the Orba One SDK, follow this guide and use your own API Key which you can obtain from the developer dashboard.

The integration of the Orba One Web SDK follows these simple steps:

  1. Install the SDK through NPM / Yarn

  2. Get an API Key

  3. Render the Orba One verification button and handle the result

Additionally, there is a non-package manager installation option. You can start using the Orba One SDK library directly by including it in your HTML file. Instructions can be found below.

1. Install the SDK

# Yarn
yarn add @orbaone/core
‚Äč
# NPM
npm install --save @orbaone/core

2. Get an API Key

Orba One uses API keys to allow access to the API and show onboarded users in your dashboard. Login to your Orba One account and create a new Orba One API key here: Developer Dashboard.

3. Render the verification button

Import the Orba One SDK

import { renderButton } from "@orbaone/core";

Example Usage

renderButton({
apiKey: "exampleAPIKey",
applicantId: "0000-0000-0000-0000",
target: "#button",
disableStyle: false,
onSuccess: (data) => {console.log(data)},
onCancelled: (data) => {console.log(data)},
onError: (err) => {console.log(err)},
steps: ['welcome'],
})

renderButton(config) Options

Parameter

Type

Description

target

string or DOMElement

The DOM element you want to mount the button on.

apiKey

string

The OrbaOne Key you obtained from the dashboard.

applicantId

string

The ID of the applicant that you want to onboard.

disableStyle

boolean (optional)

The OrbaOne Key you obtained from the dashboard.

onSuccess

function

Callback function after onboarding is complete.

onError

function

Callback function if onboarding has failed.

steps

array

Array of verification steps.

Browser

Orba One is available over unpkg CDN

<script type="text/javascript" defer="true" src="https://unpkg.com/@orbaone/[email protected]/lib/index.umd.js" />

Example Usage

<script type="text/javascript">
OrbaOne.renderButton({
apiKey: "exampleAPIKey",
applicantId: "0000-0000-0000-0000",
target: "#button",
disableStyle: false,
onSuccess: (data) => {
console.log(data);
},
onError: (err) => {
console.log(err);
},
onCancelled: (state) => {
console.log(state);
},
steps: ["welcome"],
});
</script>