API Reference

You can also configure and customise UI, branding, and the flow of authentication using theflow_behaviour and flow_style under body parameters when you call Create an Authentication endpoint.

Customise Visual of the Face Access Flow

There are six different parameters that you can configure under the flow_style object as follows:

  • primary_colour_hex: The primary colour using a valid HEX colour code (e.g., #ffffff).
  • header_text_colour_hex: The colour of the header text within the challenge using a valid HEX colour code (e.g., #ffffff).
  • body_text_colour_hex: The colour of the body text using a valid HEX colour code (e.g., #ffffff).
  • logo_public_url: A logo URL.
  • terms_of_service_url: The URL for the terms of service.
  • show_consent_checkbox: Indicates whether a consent checkbox should be displayed to users.

For details, please refer to the picture below:

Customise the Behaviour of the Face Access Flow

Under the flow_behaviour object, configure the exit_redirect_url parameter, where the user will be redirected if the biometric authentication is complete.

For details, please refer to the illustration below.

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.