SDK WEB
This is a walkthrough of how you can itegrate the Oboarding or Authentication SDK for Web applications.
Last updated
This is a walkthrough of how you can itegrate the Oboarding or Authentication 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 Authentication, you should follow those steps:
Integrate the SDK
Get a token
Start an onboarding or authentication flow
Get the user workflow result from SDK (Message Handling)
Get the Analysis result from API
Our web SDK is hosted by npm as a private package. So in order to install it, you'll need an npm account.
Once you provide us with your npm account we can grant you an access permission to the private package. You will receive the invitation email to connect to our private repository. You'll then be able to install the needed package (Onboarding_desktop or Authenticate):
Use the credentials you recieved from ShareID's team to get an authentcation token and launch an onboarding or authentication workflow.
Depending on the SDK you are integrating (Onboarding/Authenticate), you may use an API here Get a Token
Once you have your token, you can start an onboarding/Authenticate process by setting your web SDK as described below:
For onboarding:
For Authenticate:
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 OnSuccess Callback function is triggered. Exemple:
Other Props can also be specified:
token: the token you get through the authentication process.
language: the language used in the sdk.
debug: display more detailed error messages in the browser console if True
dark: handle dark mode if True
theme: this propriety allows you to customize the SDK to yours colors and text style (see examples in the FAQs).
callback functions: these functions are used to manage the interactions ShareID's service. Examples of the use of callbacks (OnFail, OnExit, OnSuccess) are presented in the FAQs section.
OnSuccess is triggered when the videos of the user has been successfully uploaded (sent to backend for verification).
OnFail is triggered when something goes wrong during the acquisition process of the user or his identity document videos (an error occurred, example: token expired and user didn't start the process). The list of errors (code + message are detailed in the FAQs section).
OnExit is triggered when the user exist the verification process without finishing all the steps. It is only triggered if the token has expired.
redirectUrl redirects the user at the end of the onboarding process
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.
Exemple:
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.
Exemple:
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.
See Fetch result for more details.
You can set the following values to customize the SDK's colors and text style:
Example of SdkCssColorType:
Example of SdkCssTextType:
The accepted values for colors are:
The accepted values for font size are:
The accepted values for FontWeight are: