User-Agent Header

Learn about User-Agent Headers and how they are generated by the FaceTec SDKs.

Usage

The User-Agent Header (User Agent String) is used by Servers and Network Peers when processing an API request from a Client. This unique string allows websites to determine specific characteristics about the Client making a network request, such as its Operating System and Platform Type.

To make API requests with the FaceTec SDKs, Your Team will need to create a User-Agent Header with createFaceTecAPIUserAgentString(sessionID).

String Format

When FaceTecSDK.createFaceTecAPIUserAgentString(sessionID) is called, a string of the following format will be generated:

facetec|sdk|<Platform>|<Package ID>|<Device License Key Identifier>|<Installation ID>|<Device Model>|<SDK Version>|<Language Type>|<Language>|<Session ID>

Setting Up the User-Agent Headers

User-Agent Headers must be included in the FaceTec Server API calls by setting the “X-User-Agent” HTTP Header to the output of the FaceTec Device SDK’s createFaceTecAPIUserAgentString function in a network request. The populated metadata is then parsed and saved in the FaceTec Server. An example of how to properly set the “X-User-Agent” HTTP Header is shown below: 

Important Note: Please note that setting up the User-Agent Headers is not a requirement for the FaceTec SDKs and is only used to store metadata that could be useful in the future for your own auditing.