Web SDK
Web SDK parameters
Set the look, the texts and the languages of the widget in the editor.
These are the settings of the Web SDK tab in the scenario editor. Every change shows at once in the preview on the right, and your users see it in the embedded widget. Launch options such as scenarioId, clientKey, theme and the callbacks are not set here. They are passed when your page opens the widget. See installation.
Color theme
A toggle selects the dark or the light theme. The selected theme is used in the preview and as the default when the widget opens, unless your page overrides it with theme.
General
- Logo. Upload one logo for the dark theme and one for the light theme. Use an image with a transparent background, in PNG or SVG format.
- Terms and conditions, privacy policy. Links to your own documents. They appear on the start screens.
- Allow desktop camera. When on, the user can verify on the computer with the button to continue on this device. When off, the user is asked to continue on a phone with a QR code or a link.
Colors
- Background: main, secondary and active.
- Text: main and secondary.
- Brand colors: the brand color, an additional color, success and error.
- Buttons: the text color of the primary button, and text, background and border of the secondary button.
- Additional: loader, shadow and borders.
Check the contrast of text and buttons in all states, so that your widget stays readable.
Texts
Texts are grouped by screen, and the preview lets you step through the screens of the scenario:
- Start screen: the title, the instruction points, the data-processing note, and the QR block with its caption.
- Document capture: short hints for photographing the document, for example to place it on a flat surface and keep all edges in the frame.
- Selfie with document: hints for holding the document next to the face.
- Status texts: the messages after a step, such as the confirmation after a document is received.
Keep texts short. If recognition fails, the widget shows an error screen on its own.
Languages
Enable the interface languages your audience needs. The widget offers 29 interface languages, and the user can switch between the enabled ones. If you use custom texts, localize them for each language you enable.
What appears where
| Setting | Where the user sees it |
|---|---|
| Logos and colors | On all steps: header, buttons, success and error icons. |
| Legal links | On the start screen. |
| Texts | On the matching step: start, document, selfie, result. |
| Languages | In the language selector. |
After you save, all new sessions show the widget with your branding and texts.
Next: the client key
Learn how to encrypt the identifier you pass to the widget.
Open working with clientKey