Web SDK introduction

What it is

The Web SDK is a ready-to-use widget for web applications. It runs on top of your page and guides the user through the steps of your scenario: photographing the document, taking a selfie, following the liveness step, and sending the result to your backend. You switch individual steps on and off in the scenario.

Where it runs

The widget works in desktop and mobile browsers. The only permission the user must give is camera access during capture. Branding, texts and languages are configured in the scenario editor. See parameters.

What the user sees

1. Start. The user opens your page and sees the start screen, with a QR code or link for continuing on a phone. The widget offers a language selector.
2. Loading. The widget loads.
3. Instructions. A short note asks the user to prepare the document and find good light.
4. Document guidance. The widget shows which document to photograph and how to place it in the frame.
5. Camera permission. The browser asks for camera access. The user must allow it, otherwise capture is not available.
6. Document capture. The document must be fully visible, clear of fingers and glare, with readable text.
7. Document accepted. If the type and quality are right, the widget confirms. Otherwise it tells the user what to fix.
8. Selfie and liveness. The user takes a selfie, and in a liveness step moves the face through two ovals, as the scenario requires.
9. Completion. After all steps are processed, the widget tells the user that verification is complete.

Environment

• Serve the page over HTTPS. Browsers give camera access only to secure pages.
• If the user denies the camera, the widget shows a screen that explains how to allow it.
• If the camera of a computer is not suitable, or your scenario does not allow it, the widget offers a QR code and a link to continue on a smartphone.
• On a phone, capture runs in portrait orientation. If the user turns the phone, the widget asks to turn it back.
• If the network drops, the widget shows a screen with a retry button.
• Embedded browsers of messengers and social apps can limit camera access. Ask users to open the page in the system browser.
• To show the widget inside a mobile app, see mobile apps and WebView.

When to use it

• You want remote identity verification in your product, such as customer or worker onboarding, without building a camera front end.
• You need documents, selfies, liveness and anti-fraud checks behind one widget.
• You want the same behaviour on desktop and in mobile browsers.

Tips for good captures

• Capture in good light, without strong glare or deep shadows.
• Keep the whole document in the frame. Do not cover the photo, the stamp, the signatures or the numbers.
• Hold the camera steady and retake the picture if needed.

Next

Installation shows how to add the widget to your page.