API Reference

📚 Get familiar with some of the terms we use.

Access Token

A unique authentication token is obtained using the API credentials. This token is required for making authenticated API requests.

Authentication Challenge

The process initiated by the client prompts users to undergo authentication.

Biometric Genome (FeatureID)

Face Access' proprietary and non-reversible representation of a face used for face matching without transmitting or using actual face images in the API.

Client ID

A unique identifier the authorisation server assigns to a client application. It is used to identify the client when making API requests and during the authentication process.

Credentials

The authentication details, including API keys and other necessary information, are provided to users after their access request is approved.

Cross-Origin Resource Sharing (CORS)

A security feature implemented by browsers to restrict web pages from making requests to a different domain than the one that served the web page. It can be configured on the server side to enable or restrict cross-origin API requests.

Customer Reference

A unique identifier or code assigned to a specific customer or user. It is often used to associate customers with their data and activities within a system.

Flow Behaviour

The behaviour or actions that should be taken during the authentication flow for different scenarios.

Grant Type

The method used to obtain an access token in OAuth 2.0 authentication.

Match Result

The outcome of a matching process. For example, a face match indicates whether the faces being compared match or not.

MIME Type

A "MIME type" (Multipurpose Internet Mail Extensions type) is a label used to identify the type of data contained in a file or served by a web server.

Webhooks

A mechanism where the API sends real-time notifications or data to a specified URL when specific events or triggers occur. It allows applications to receive and react to events as they happen.

📌 Need Help?

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