​
apiURL
string
required
This is the address of the Legitimuz API.Example: https://api.legitimuz.com
​
appURL
string
required
This is the address of Legitimuz Verify.Example: https://liveness.legitimuz.com
​
token
string
required
The token is your integration token. You can generate an integration token on the integrations page under the installation tab in the Legitimuz Dashboard.
​
lang
string: pt | en | es
default:"pt"
The lang option sets the language that will be used in the Face Index flow.
​
onSuccess
function: (eventName: 'faceindex'): void
The success callback is triggered when success occurs at any stage of the Face Index flow. A string with the stage where success occurred is passed as a parameter.Examples:
<div id="legitimuz-root"></div>
<script src="https://cdn.legitimuz.com/js/sdk/faceindex.js"></script>
<script type="text/javascript">
  const sdkInstance = LegitimuzFaceIndex({
    /* options */
    onSuccess(eventName) {
      console.log(eventName); // faceindex
    },
  });

  sdkInstance.mount();
</script>
​
onError
function: (eventName: 'faceindex'): void
The error callback is triggered when an error occurs at any stage of the Face Index flow. A string with the stage where the error occurred is passed as a parameter.Examples:
<div id="legitimuz-root"></div>
<script src="https://cdn.legitimuz.com/js/sdk/faceindex.js"></script>
<script type="text/javascript">
  const sdkInstance = LegitimuzFaceIndex({
    /* options */
    onError(eventName) {
      console.log(eventName); // faceindex
    },
  });

  sdkInstance.mount();
</script>