Web
This is a walkthrough of how you can integrate the Onboarding or Authenticate SDK for Web applications.
Last updated
This is a walkthrough of how you can integrate the Onboarding or Authenticate SDK for Web applications.
Last updated
The web SDK is a React component that enables you to trigger an identity verification.
It is responsive and works on both desktop and mobile browsers.
The user is asked to scan a QR code or use the generated link:
Once the user is on his phone, he is informed about his progress in the onboarding process
In order to perform an Onboarding or an Authenticate, you should follow those steps:
The Web SDK is hosted on npm as a private package. To install it, you’ll need an npm account.
Once you provide us with your npm account, we will grant you access to the private package. (You will receive an invitation email)
After accepting the invitation, you’ll be able to install the following required package(s):
Use the credentials you received from ShareID's team to get an authentication token and launch an onboarding or authenticate workflow.
Once you have your token, you can start the process by setting your web SDK as described below:
token
The token received from your backend after the authentication process.
language
Language used in the SDK (en, fr, etc.).
debug
If true, enables detailed logs in the browser console.
dark
If true, Enables dark mode for the SDK UI.
theme
redirectUrl
Redirects the user at the end of the onboarding process.
The user will be guided to scan a QR code and follow the steps to provide his data : videos of his document and/or his face are recorded and sent to ShareID's backend for processing.
When the user finishes those steps, the appropriate callback function is triggered.
The callback functions are used to manage the interactions ShareID's service.
This the callback function that triggers when something goes wrong during the acquisition process of the user or his identity document videos. You can call your backend to react to this event.
This the callback function that triggers when the user exist the verification process without finishing all the steps.
This callback function triggers when the videos of the identity document and the user has been successfully uploaded. You can call your backend to react to this event.
When the processing of an onboarding request is finished, you may receive the result through the callback if you provided it. You may also, fetch yourself the result by calling our API.
The ShareID Web SDK allows you to fully customise its colors and text styles.
You can do so by passing a theme prop to the ShareID component.
Customize background and action-related colors for both light and dark modes.
The accepted values for colors are:
Customise font styles for various text elements in the SDK.
The accepted values for font size are:
The accepted values for FontWeight are:
: install and import the SDK.
: request a token using your business credentials.
: launch a user workflow.
: use the Message handler to get insights about the user workflow.
: use your callback or the endpoint to get the analysis result.
Depending on the SDK you are integrating (Onboarding/Authenticate), you may use an API here
Allows you to customize the SDK colors and text style (see ).
See for more details.