Properties

SDK Provider configuration properties.

The Facephi SDK Provider component is configurable through the following properties, offering different behaviors for the possible use cases that may be needed.

Constants

Some constants or enums can be imported from @facephi/sdk-web-wc to make implementations easier.

import { Language, TypeFamily, TrackingSteps } from '@facephi/sdk-web-wc'

Configuration example

import { Language, TypeFamily, TrackingSteps } from '@facephi/sdk-web-wc';

<facephi-sdk-provider
    apikey={process.env.FACEPHI_SDK_APIKEY}
    steps={`${TrackingSteps.start},${TrackingSteps.selphidWidget},${TrackingSteps.selphiWidget},${TrackingSteps.finish}`}
    type={TypeFamily.onboarding}
    customerId={'user-7f3a9c21'}
    language={Language.en}
/>

---

Recommendation: Configure the properties using JavaScript, JSX, or your framework's bindings (React, Vue, Angular, etc.). Avoid native HTML configuration with attributes (nombre-atributo="valor"), as it may lose the typing and formatting expected by the component.

SDK Provider configuration properties

Using the SDK Provider properties, you can configure the behavior and Flow of its components.

Required

• apikey: Mandatory SDK Web License provided by Facephi.

Tracking

• steps: Order of the steps in the Flow registered on the platform.

• type: Type of operation registered on the platform (Onboarding or authentication).

• customerId: User or client identifier for the operation.

• operationId: Identifier of the operation on the platform.

• tenantId: Tenant identifier for Tracking on the platform.

Settings

• autoInitTracking: Automatically starts Tracking when the SDK is loaded.

• autoInitWorkflow: Automatically starts the workflow when the SDK is loaded.

• landingApiKey: API key for the Landing service.

• proxy: Proxy server URL for SDK requests.

• resourcesPath: Custom path to load SDK resources.

• qr: Enables mobile capture via QR Code on desktop.

• qrExtraParams: Extra parameters in the mobile QR Flow URL.

• settingsStrictness: Controls whether an invalid configuration value blocks the SDK or is replaced with its default value.

• waitRequest: Waits for data submission requests to finish before advancing in the Flow.

Customization

• desktopView: Enables the SDK desktop view.

• language: Language of the SDK texts and its components.

• theme: Visual theme of the SDK (colors, logo, and typography).

• customAnimations: Centralized custom animations for the SDK components.

• loadingAnimation: Path to a custom loading animation for the provider.

Development

• debug: Enables logs and developer options.

• disabled: Disables Tracking and the Flow service.