Getting Started

Versioning

The API version is increased every time a major change is made to avoid breaking backward compatibility. The method we utilize is to specify the version in the request path of the API:

• Users endpoint in version 1.1 <domain>/api/1.1/users

When starting a new project, you should always use the latest version of the API.

Request Parameters Format

There are four ways to provide parameters to the API methods:

• application/json

  • Parameters are represented by a JSON contained in the POST body.

• application/x-www-form-urlencoded

  • Parameters are represented by form field names and values.

• multipart/form-data

  • Parameters are encoded into separate parts. This format supports uploading a photo image file in a single request.

• query string

  • Parameters are appended to request URI. When passing parameters in a query string, complex structures (such as boxes) should be encoded in JSON.

All responses are in JSON format and UTF-8 encoding

Authentication Headers

All API methods require a token-based HTTP Authentication.

In order to authenticate, the Authorization HTTP header must contain:

Field	Type	Description
x-biometrid-key	String	Application client key.
x-biometrid-secret	String	Application client secret.

Please contact [e-mail] in order to request authorization credentials.

To check the examples without writing code, we recommend using Advanced REST Client or similar tool and entering request parameters through their GUI.