Create an Authentication

post

https://api.{region}.faceaccess.io/v1/create-challenge

🚀 Start biometric authentication process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Info:
We offer FaceAccess service across multiple regions. When integrating with FaceAccess, ensure that you use the correct Base URL for your region:

Australia (AU): https://api.au.faceaccess.io

Canada (CA): https://api.ca.faceaccess.io

United Kingdom (UK): https://api.uk.faceaccess.io

United States (US): https://api.us.faceaccess.io

Body Params

customer_reference

string

An optional field that you can pass in the request, often used to carry an identifying value.

compare_to_featids

array of strings

A string of characters created from a person's face in the format of base64. Used for challenge with FeatureIDs.

compare_to_featids

flow_behaviour

object

The flow behaviour details.

liveness_only

boolean

Defaults to false

Set to true if only liveness is required to be challenged.

notifications

object

The webhook notification details.

flow_style

object

Customizes the flow style.

expires_in_seconds

int32

Defaults to 900

Time in seconds for which the challenge URL is valid. Defaults to 900 (15 minutes).

require_consent

boolean

Defaults to true

Flag indicating if user consent is required. If false, the privacy screen is disabled.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Info:

200200

400400

401401

403403

422422