Web SDK customizations
Stages
Stages can be customized by providing stage objects. A state object has two components - name
and options
.
Name
The name attribute is the stage name. The possible values are: intro
, userConsentCapture
, documentCapture
, faceCapture
, poaCapture
, and completion
.
When the userConsentCapture
stage is enabled, the onExit callback must be used to handle instances where your client does not grant their consent to be checked according to our prevailing Terms of Services and Privacy statement. Please refer to SDK Settings for further details on the onExit callback.
Please make sure you pass the clientConsent
parameter when consent is granted by your client.
Options
The options
object allows the customization of each stage as follows:
Example options object
Branding
If you'd like to customize the look-and-feel of the SDK, you can provide a branding
object with the following attributes:
Appearance
The appearance
object allows you to customize the color scheme of the SDK with CSS values (e.g. RGBA, Hex). Customizable attributes include:
Logo
The logo
object has two attributes:
lightLogoUrl
: URL for your logo's light versiondarkLogoUrl
: URL for your logo's dark version
Example of logo branding
Text Brand
The textBrand
attribute represents the textual format of your brand.
Example of text branding
If logo
and textBrand
attributes are specified at the same time, logo
takes precedence.
Last updated