Biometric API endpoints

Updated December 2, 2019

Use this guide to enable the Authentication API to generate and validate biometric login requests for end user access to applications.

Prerequisites

Configure the SecureAuth® Identity Platform to use "Biometric identification," enable the API for a SecureAuth IdP realm, and configure a request header. See the Authentication API guide.

GET /factors

Use the GET /factors method to access the end user's profile and generate a biometric response.

The factors are returned if you use /api/v2 and the user status in Active Directory matches one of the following:

  • InvalidGroup

  • Disabled

  • Lockout

  • PasswordExpired

  • AccountExpired

HTTP Method

URI

Example

SecureAuth product

GET

/api/v2/users/<username>/factors

https://secureauth.company.com/api/v2/users/jsmith/factors

version 19.07 or later

POST /auth

The POST method validates the end user biometric response.

HTTP Method

URI

Example

SecureAuth product

POST

/api/v2/auth

https://secureauth.company.com/api/v2/auth

version 19.07 or later

Request POST payload

Response payload

GET /auth

Combine the GET /auth method and the reference ID to contact the endpoint to validate if the end user has accepted the request.

HTTP Method

URI

Example

SecureAuth product

GET

/api/v2/auth/<reference_id>

https://secureauth.company.com/api/v2/auth/5523d444-e92e-4297-ae27-fbc6cb3288b3

version 19.07 or later