Skip to main content

Facephi SDK Provider

The facephi-sdk-provider is the core Web Component of the Web SDK, designed to streamline 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 required credentials for the use of the SDK Facephi Provider Component, like Tokens or Keys.


Integration Example

Short example of the Facephi SDK Provider integration in vanilla HTML:

<facephi-sdk-provider
apikey="YOUR_APIKEY"
steps="START,SELPHI_WIDGET,FINISH"
onemitoperationid="handleOperationId(event)"
onerror="handleError(event)"
>
<!-- Widgets -->
</facephi-sdk-provider>

<script>
function handleOperationId(event) {
console.log('Operation ID:', event.detail);
}
function handleError(error) {
console.error('Facephi SDK Error:', error.detail);
}
</script>

The apikey property is required in order to launch the web component.


Configuration

The SDK Provider can be configured through HTML attributes.

The provider component will emit events during its life cycle.

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


Benefits of Using FacephiSDKProvider

  1. Streamlined Biometric Integration: Simplifies complex processes like facial recognition and document verification.

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

  3. Multi-language Support: Ensure accessibility for users worldwide.

  4. Custom Branding: Align the SDK’s appearance with your brand.

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