v10 Testing API

The FaceTec Testing API provides a variety of functions for processing Liveness Checks, Enrollments, Re-Verifications, Identity Checks, Age Checks, and Image Comparisons.

Please Note: The FaceTec Testing API is meant for testing purposes only. In production, you will deploy instances of FaceTec Server, which you can interact with per the specifications of your own application requirements.

Basic Usage

URL

All requests should be made to the API at https://api.facetec.com/api/v4/biometrics. All available API endpoints listed below should be appended to this base URL. For example, the /status endpoint can be reached at https://api.facetec.com/api/v4/biometrics/status.

Please Note: The Testing API's URL is automatically added to your App's configuration file when Connect to Testing API is chosen in Configuration Wizard.

Authentication

The FaceTec Testing API requires the X-Device-Key header to be set to your Device Key. Please check your Account Page for your Device Key and the Sample App code for details on how to set this in your code.

X-User-Agent Header

For 3D Liveness, Enrollment, and 3D to 3D Face Matching to function properly, the X-User-Agent header must be specified. The string to set this Header comes from the SDK APIs. Please review the Sample App for reference code on how to set this in your code.

To learn more about the User Agent Header, see the User Agent Header Mini-guide.

Limits

  • Usage is limited to 50 requests per minute.

  • Only allowed to test 100 devices.

  • Calls to the /3d-db/search API will search through all enrollments and return no more than 10 enrollments with the highest scores.

Please Note: You can find all of the API Calls in our API Guide.