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

Init Session Configuration

license

type: string

Allows setting the License for the components. This License must be provided by Facephi.

mLicense: "valid license“

licenseUrl

type: string

Sets the URL where the Core component validates the License remotely. This Endpoint must be provided by Facephi.

mLicenseUrl: "https://***.***.pro"

licenseApiKey

type: string

Sets the API key that is sent to obtain the service License.

mLicenseApiKey: "valid ApiKey"

enableTracking

type: boolean

Enables or disables the use of the Tracking component. This makes it possible to see information about what the client does on the Facephi platform. This component runs in the background while the rest of the installed components are executed, and analyzes the user's behavior during the current process.

The result will be returned through a Promise containing an object of the SdkCoreResult class. More information about how this class works will be added in the section 6.

locale

This is a String that allows changing the locale and language of the Widget. Some examples of values it can have are the following:

  • ““ to use the system language

  • “es” for Spanish.

  • “en” for English.

  • “fr” for French.

enableDebugMode

Boolean that enables or disables showing console logs of what the components do.

enableLocation

Boolean that enables or disables the request for geolocation permissions through an operating system pop-up. When enabled, the application will request access to the device's location from the user. IMPORTANT: It applies only to iOS. By default it is always true.

internalOptions

Record<String, String> to which key/value-type parameters are passed for various specific configurations.

For example, if {"SKIP_ENV_CHECK": "true"} is passed, the check for rooted devices, emulators, fraudulent apps, etc. is removed before using the rest of the components.

Last updated