Getting Started

API Versions

The API version is increased every time a major change is made and allows us to avoid breaking backward compatibility. The API version should be specified in the request path (for example v1 in /api/1.0/users). The most recent version in v1. When starting a new project, you should always use the latest version of the API.

Parameters Format

There are three ways to pass parameters to the API methods

• application/json: parameters are represented by a JSON contained in the 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 way supports uploading a photo image file in the same 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 needs to contain an "Application client key" and "Application client secret"

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 an auth token.

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