For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDK Provider

The facephi-sdk-provider is the main web component of the SDK Web, designed to optimize biometric operations such as Facial Recognition, document verification, and user tracking.

This guide provides a detailed overview of its properties, events, and methods to help you integrate it effectively into your project.

The Facephi team will provide the necessary credentials for using the Facephi SDK Provider component, such as Tokens or Keys.

Type: HTMLFacephiSdkProviderElement


Integration Example

<facephi-sdk-provider
    apikey={process.env.FACEPHI_SDK_APIKEY}
    steps={`${TrackingSteps.start},${TrackingSteps.selphidWidget},${TrackingSteps.selphiWidget},${TrackingSteps.finish}`}
    onEmitOperationId={(event) => console.log('Operation ID:', event.detail)}
    onEmitError={(event) => console.error('SDK Error:', event.detail)}
/>

The property apikey is required to launch the web component.


Settings

The SDK Provider is configured through JavaScript or JSX properties.

Properties

The provider component will emit events during its lifecycle.

Events

Some functions are provided with the component to offer additional utilities.

Methods

The style of the Components can be highly customized.

Customization

Benefits of Using FacephiSDKProvider

  • Optimized Biometric Integration: Simplifies complex processes such as Facial Recognition and document verification.

  • Highly Configurable: Adaptable properties and events for different workflows and business needs.

  • Multilingual Support: Ensures accessibility for users worldwide.

  • Brand Customization: Aligns the SDK's appearance with your brand.

By leveraging the features and flexibility of the facephi-sdk-provider, you can implement a robust and easy-to-use biometric solution, tailored to your application’s requirements.

Last updated