Widget config parameters
Below is the full list of configurable parameters for Business Score widget.js front end library.
Business Score approved parameters
Updating parameters denoted with an * require approval from the Business Score partner team.
| Parameter name | Description | type | default |
|---|---|---|---|
| publicKey | Public key required to instantiate the widget provided by Business Score | string | - |
| elementId | Html element id where the widget will be displayed | string | - |
| popup | Pass this flag as true, if you want embed to be displayed as a popup | boolean | false |
| width | Express the width of the widget in px or set it to full page width with 100vw | string | auto |
| height | Express the height of the widget in pixels e.g 700 px | string | auto |
| letterLogoUrl * | Provide a url for the logo displayed in the widget banner | url | Business Score logo |
| logoUrl * | Provide a url for the logo displayed in the widget welcome | url | Business Score Icon |
| primaryColor * | string | #007AFF | |
| secondaryColor * | string | ||
| fontName * | Available font names - 'Rubik', 'Itim', 'Raleway', 'Lato', 'Nunito', 'Antonio', 'Inter' | string | Inter |
| partnerName * | Providing a partnerName updates the main welcome widget message to say "partnerName partners with Business Score..." | string | - |
| captchaEnabled * | Toggle captcha on the get started button | boolean | true |
| accessToken * | Allows you to pre-authenticate an applicant to the widget. To retrieve an access token, you will need this endpoint | string | - |
| kycEnabled * | This enables/disables the KYC module of the widget. | boolean | true |
| exitEnabled | Disable exit | boolean | true |